Quick Start

The Speechly Quick Start helps you get started on developing with Speechly.

Below are three different ways for you to start trying out Speechly. They are self-contained, and you can freely choose which one you would like to start with. However, the first one (Video Quick Start) is recommended for everyone.

1) Video Quick Start

This Quick Start will guide you through the basics of building Spoken Language Understanding models with Speechly Dashboard. It covers the following steps:

  1. Creating an application
  2. Creating your first Configuration
  3. Trying out the application in the Speechly Playground

2) Web Integration Quick Start

Option 1: A walk-through on integrating the Speechly Browser-client to a Web based application can be found in this simple but informative tutorial. You can either use the ready-made Application Id given on the page (Usage section), but we recommend replacing this with your own (maybe after completing the Video Quick Start).

Option 2: As an alternative to the above tutorial, we also provide a Web Speech API compliant speech recognition polyfill. This is especially recommended if you already have an application that uses the Web Speech API, and only need speech-to-text functionality. Instructions for deploying a speech-to-text Application ID can be found here.

3) Complete Integration

Do you already have an application that you would like to integrate with Speechly?

  1. Sign-up on the Speechly Dashboard.
  2. Create a new application on the Dashboard, and deploy the Home Automation Configuration. (Also see the video tutorial above.)
  3. Install and take a Client Library of your choice into use. They are available for Web, React, iOS and Android. Use the Application Id that you obtained in step 2. above. There is no need to do anything in particular with the events returned by the API yet. Just log them to a console.
  4. Make a test utterance from your own application, and inspect the returned events to get an idea of how the API works.

After you’ve completed this, the next step is to design a configuration that is tailored for your application. (The reason to deploy the Home Automation example at first is to give an overview of the end-to-end integration process that you would follow when developing a voice UI with Speechly.)

  1. Once you have written a configuration on your own, you should change your application logic so that it reacts to the returned events in an appropriate manner.

Learn more!


Profile image for Antti Ukkonen

Last updated by Antti Ukkonen on June 2, 2021 at 13:21 +0300

Found an error on our documentation? Please file an issue or make a pull request