Generate an API Token

You can access the Voxable API by generating an API token.

  1. From the profile dropdown menu, select Profile.

  2. In the left-hand menu, select API.

  3. Click the “Create an API Token” button to generate a new Voxable API token.

    An image of the Voxable product's API token interface.
  4. Once the token is generated, there are two options for how to access the Voxable API:

Authorization

Calls to the Voxable API should include the generated token in an Authorization header as Bearer [TOKEN].

Documentation

Review the Voxable API documentation for example code and a list of all available API calls.

Use the Voxable CLI

The Voxable CLI gives you easy access to Voxable data:

An animation showing a user exporting a Voxable project's data with the CLI.

Authentication

A .voxablerc.yml configuration file must be in place with the API token. This can be in the same directory in which voxable is run, or any directory above it.

You can also copy code to execute on the terminal that will set up this file in your home directory from your API token settings page:

An API token user interface from the Voxable product that reads,

Plugins

Transform Voxable design data into a variety of useful formats using Open Source Voxable CLI plugins. To install the Bespoken plugin, run the following command:

voxable plugins:install bespoken

Then export Voxable project data to transform it into Bespoken tests. Here is a transformation of the Simple Project from above:

$ voxable bespoken:transform [PROJECT_ID]
📦 Exporting project...... done
---
configuration:
locales: en-US

---

- test: Launch request, add task
- "Alexa, open Simple Project.":"Hello! I am Simple Project. You can say, \"Add a task,\" or \"cancel\" to quit. How can I help you today?"
- "Add a task.":"Sorry, I'm not going to do that, actually. Goodbye!"

- test: Launch request, add task
- "Alexa, open Simple Project.":"Hello! I am Simple Project. You can say, \"Add a task,\" or \"cancel\" to quit. How can I help you today?"
- "Cancel.":"Goodbye!"

- test: Launch request only
- "Alexa, open Simple Project.":"Hello! I am Simple Project. You can say, \"Add a task,\" or \"cancel\" to quit. How can I help you today?"
Did this answer your question?