curl --request POST \
--url https://general-runtime.voiceflow.com/v4/interact/stream \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 123,
"metadata": {}
},
"variables": {},
"state": "<unknown>",
"config": {}
}
'{
"event": "trace",
"data": {
"type": "audio",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 123
},
"paths": [
{
"label": "<string>",
"event": {
"type": "<string>",
"payload": "<unknown>",
"diagramID": "<string>",
"time": 123,
"metadata": {}
}
}
],
"defaultPath": 123,
"time": 123,
"turnID": "<string>",
"handleID": "<string>"
},
"id": "<string>",
"type": "event"
}Returns a stream of trace events followed by an end event using SSE.
curl --request POST \
--url https://general-runtime.voiceflow.com/v4/interact/stream \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 123,
"metadata": {}
},
"variables": {},
"state": "<unknown>",
"config": {}
}
'{
"event": "trace",
"data": {
"type": "audio",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 123
},
"paths": [
{
"label": "<string>",
"event": {
"type": "<string>",
"payload": "<unknown>",
"diagramID": "<string>",
"time": 123,
"metadata": {}
}
}
],
"defaultPath": 123,
"time": 123,
"turnID": "<string>",
"handleID": "<string>"
},
"id": "<string>",
"type": "event"
}Call Start session to begin a new conversation and receive aDocumentation Index
Fetch the complete documentation index at: https://docs.voiceflow.com/llms.txt
Use this file to discover all available pages before exploring further.
sessionKey. Then, pass the session key as the authorization header on this endpoint to send actions and receive traces from your agent.
Each request sends an action describing what happened on the user’s side. Actions include sending a text message, selecting a button, signaling a no-reply, or continuing after a handoff. The most common are launch (to start a conversation) and text (to send a user message).
For streaming responses, use Interact (non-stream) instead.Session key returned from the start session endpoint.
The user's action for this conversation turn. Most commonly, the text action is used to send a message to the agent as a user.
Key-value pairs to set or update on the session before this turn is processed. Useful for injecting context like a user's name, account tier, or current page. Learn more.
Hide child attributes
Traces contain responses, media and metadata generated by the conversation runtime.
trace Hide child attributes
audio Hide child attributes
event Was this page helpful?