Download OpenAPI specification here.

The Dialog Manager API is an HTTP API served by Voiceflow's dialog management server. It allows your Voiceflow project to be easily integrated into any interface: chatbot, voice assistant, IVR, web chat, and more - without the hassle of implementing the conversational flow using code.

By sending a request of what a user wants to do, you can use your Voiceflow project to generate the response.

Quick Start

For developers eager to get started without worrying about the details, here are a few quick steps to make your first call with the API:

  1. Create a project. You need to first build a conversational project on Voiceflow Creator.
  2. Create API Key. An admin of your Voiceflow workspace can create and manage API Keys under Workspace Settings / Developers.
  3. Make a test call. Use the examples below to make an API call. Make subsequent calls to the same endpoint, changing the payload to reflect what the user might say. See how the response trace changes based on where in the project the user is.
    Make sure to replace the {apiKey} with what you've gathered on step 2.
  4. Implement your application. Get familiar with the API by reading the rest of this documentation, and power the next conversation with your Voiceflow project!

Endpoint

The standard URL base for all Dialog Manager API calls: Note: This will be different if you are self-hosting or on a private cloud.

https://general-runtime.voiceflow.com

Authentication

All requests made to the Dialog Manager API must be validated with an API Key. An admin of your Voiceflow workspace can create and manage API Keys under Workspace Settings / Developers.

Security Scheme Type

API Key

Header parameter name:

Authorization