Documentation

Powered by Algolia

Getting started

Follow the steps below to learn how to use the Alan platform to add a conversational voice experience to your application:

  1. Start by watching the Alan Studio Walkthrough.

  2. Sign up for the Alan Studio or sign in if you are already registered.
  3. Review our public projects on GitHub and tutorials for adding a voice experience:

  4. Review Alan documentation on how to use the Alan platform features and functionality:

    • Alan projects: learn how to work with projects in the Alan Studio
    • Voice scripts: find out what voice scripts are and how you can build them in the Alan Studio
    • Versions and environments: learn how to create different versions of voice scripts and publish them to different environments
    • Script testing: check what tools Alan provides to test and troubleshoot your voice scripts
    • Alan Playground: learn how to use the Alan mobile application to get to know how a voice interface works and test your voice scripts
    • Analytics: see how you can get statistics on users interacting with your application with voice and optimize the dialog flow
    • Customizing the Alan button: learn how to customize the Alan button to fit your application needs
  5. Check the Alan API references:

    • Server API: learn what Alan functionality you can use to build a voice script
    • Client API: get to know the Client API for the Alan button
  6. Integrate Alan into your application. Alan offers SDKs for the following platforms:

What's next?

If you need more information about the Alan platform, check the following resources: