Voiceflow bearer token
Send
curl --request PUT \
--url https://realtime-api.voiceflow.com/v1/stable/conversation/<userID> \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}),
});
const data = await response.json();import requests
response = requests.put(
'https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
},
)
data = response.json()vf conversation send --user-id <userID> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"traces": [
{
"type": "audio",
"paths": [
"<TracePath>"
],
"defaultPath": 0,
"time": 0,
"turnID": "<string>",
"handleID": "<string>",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 0
}
}
]
}Advances a conversation by one turn: the body carries the action to apply, and the response carries the traces the agent produced in reply.
PUT
/v1/stable/conversation/{userID}
Send
curl --request PUT \
--url https://realtime-api.voiceflow.com/v1/stable/conversation/<userID> \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}),
});
const data = await response.json();import requests
response = requests.put(
'https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
},
)
data = response.json()vf conversation send --user-id <userID> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"traces": [
{
"type": "audio",
"paths": [
"<TracePath>"
],
"defaultPath": 0,
"time": 0,
"turnID": "<string>",
"handleID": "<string>",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 0
}
}
]
}Authorizations
Query Parameters
Body
Show child attributes
Option 1 · LaunchRequest
Option 2 · TextRequest
Option 3
Option 4 · ActionRequest
Option 5 · IntentRequest
Show child attributes
Show child attributes
BaseAction — see its attributes above
Option 6 · EventRequest
Show child attributes
Show child attributes
BaseAction — see its attributes above
Option 7 · PathRequest
Show child attributes
Show child attributes
BaseAction — see its attributes above
Option 8 · NoReplyRequest
Option 9 · MessageRequest
Option 10 · EndRequest
Option 11 · DTMFRequest
Option 12 · LiveAgentHandoffRequest
Show child attributes
Show child attributes
Option 1 · LiveAgentHandoffMessagePayload
Option 2 · LiveAgentHandoffFileUploadPayload
Option 3 · LiveAgentHandoffContinueConversationPayload
Option 13 · GeneralRequest
Show child attributes
Show child attributes
BaseAction — see its attributes above
Option 14 · AlexaIntentRequest
Show child attributes
Show child attributes
BaseAction — see its attributes above
IntentRequestEntity — see its attributes above
Option 15 · LegacyIntentRequest
Show child attributes
Show child attributes
BaseAction — see its attributes above
IntentRequestEntity — see its attributes above
Response
200 - application/jsonReturns 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.
Show child attributes
Option 1 · AudioTrace
Show child attributes
Option 2 · SpeakTrace
Show child attributes
TracePath — see its attributes above
Option 3 · StreamTrace
Show child attributes
TracePath — see its attributes above
Option 4 · BlockTrace
Show child attributes
TracePath — see its attributes above
Option 5 · CardTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Option 6 · CarouselTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Show child attributes
Button — see its attributes above
Option 7 · ChannelActionTrace
Show child attributes
TracePath — see its attributes above
Option 8 · ChoiceTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Button — see its attributes above
Option 9 · CompletionTrace
Show child attributes
TracePath — see its attributes above
Option 10 · DebugTrace
Show child attributes
TracePath — see its attributes above
Option 11 · DTMFTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Option 12 · EntityFillingTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Trigger a specific intent from your conversation model.
IntentRequest — see its attributes above
Option 13 · ExitTrace
Show child attributes
TracePath — see its attributes above
Option 14 · FlowTrace
Show child attributes
TracePath — see its attributes above
Option 15 · GoToTrace
Show child attributes
TracePath — see its attributes above
Option 16 · LogTrace
Show child attributes
TracePath — see its attributes above
Option 17 · NoReplyTrace
Show child attributes
TracePath — see its attributes above
Option 18 · PathTrace
Show child attributes
TracePath — see its attributes above
Option 19 · TextTrace
Show child attributes
TracePath — see its attributes above
Option 20 · ReasoningTrace
Show child attributes
TracePath — see its attributes above
Option 21 · VisualTrace
Show child attributes
TracePath — see its attributes above
Option 22 · KnowledgeBaseTrace
Show child attributes
TracePath — see its attributes above
Option 23 · CallForwardTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Option 24 · RealtimeAgentTrace
Show child attributes
TracePath — see its attributes above
Option 25 · LiveAgentHandoffTrace
Show child attributes
TracePath — see its attributes above
Show child attributes
Option 1
object · 8 attributes:
conversationID, message, translationKey, translationParams, agent, event, provider, configOption 2
object · 9 attributes:
conversationID, message, translationKey, translationParams, agent, event, downloadMessage, continueMessage, newConversationMessageOption 3
object · 7 attributes:
conversationID, message, translationKey, translationParams, agent, event, fileOption 4
object · 6 attributes:
conversationID, message, translationKey, translationParams, agent, eventOption 26 · ToolCallTrace
Show child attributes
TracePath — see its attributes above
Was this page helpful?
Thanks for your feedback.