Skip to main content
PUT
Send

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

userID
string
required

The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.

Query Parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Body

application/json
action
object
required

Send a launch request to start a new conversation.

version
enum<string>
required

Whether to run the conversation against the draft or published version of the environment.

Available options:
draft,
published
sessionID
string

The unique ID of the conversation session to continue.

Response

200 - application/json

Returns the agent's response to the turn as an array of traces, each a typed piece of the reply such as text, speech, a card or carousel, a choice, a tool call, or a debug entry.

traces
object[]
required

An audio response event. The payload's state field selects the shape: start announces a messageID, content carries the audio in content with its encoding, and end carries the state alone.