Documentation

Powered by Algolia

Getting started

Want to create a voice assistant for your app? Follow the steps below to get started with Alan.

1. Sign up for the Alan Studio

Sign up for the Alan Studio or sign in if you are already registered. The Alan Studio is where you will create voice scripts, or conversation scenarios, for your voice assistants.

To get started with the Alan Studio, watch this walkthrough:

These resources can also be helpful to let you understand how Alan works:

2. Check Alan examples and GitHub projects


  Example scripts

In the Alan Studio, select predefined voice assistants to see how voice scripts can be organized. Start with 'Hello World'.

  GitHub projects

Review our public projects on GitHub and check example apps within them to get an idea on how voice assistants can work.

3. Check Alan API references


  Server API

Learn what Alan functionality you can use to create a script for your voice assistant in the Alan Studio.

  Client API

Learn what methods of the Alan button you can use on the client app side.

4. Integrate your app with Alan

Alan offers SDKs for different platforms to let you build the Alan voice into your app. Select the platform below to learn about integration details.

Web


iOS


Android

5. Still have questions?

Check additional materials and try our tutorials.


Tutorials

Follow step-by-step instructions on how to perform the most common tasks with Alan.

What's next?

After you integrate your app with Alan, you may find these topics, tools and resources useful:


  Alan Playground

Learn how to use Alan Playground on iOS and Android to test voice scripts and check Alan examples.

  Alan button options

Learn how to customize the Alan button to fit your app needs.

  Alan AI YouTube channel

Watch videos of voice interface use cases in existing apps.

  Alan AI Slack Community

For support, join the Alan Slack community.

If you encounter a bug, have a question or want to submit a feature request, you can also go to Alan GitHub, select the necessary Alan SDK, navigate the Issues section and create an issue there.