v1

latestOpenAPI 3.0.02026-07-2251509353.3 KB

Conversation

Public-Docs

Interact - legacy (stream)

<Note>This endpoint is deprecated. Use the Interact (stream) endpoint instead. This legacy endpoint will continue to work for now, and we'll communicate a timeline for removal when one is available. We recommend migrating as soon as possible.</Note> Returns a stream of trace events followed by an end event using SSE.

post/v2/project/{projectID}/user/{userID}/interact/stream

Path parameters

projectIDstring required

The ID of the Voiceflow project to interact with.

userIDstring required

An ID which uniquely identifies the user having the conversation.

Query parameters

modality'voice' | 'chat' | 'api'

Certain features are only available depending on your modality.

environmentstring

Which environment to target within the project.

audio_eventsboolean

If enabled, the configured speech-to-text provider will be invoked to convert system response text to audio. Audio traces will be returned from the server.

audio_encoding'audio/mp3' | 'audio/x-mulaw' | 'audio/pcm'

When audio_events are enabled, selects the encoding of audio traces returned by the server.

completion_eventsboolean

When enabled, LLM traces will be broken up into streamed-in chunks - documentation

userTimezonestring

The timezone experienced by the user in this conversation.

versionVariantstring

stateboolean

When enabled, conversation state is returned in response to each interaction.

Request body

variablesobject

Set variables for the next turn of the conversation.

sessionIDstring

Unique ID of the conversation session.