curl --request POST \
--url https://general-runtime.voiceflow.com/v4/interact \
--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": {}
}
'{
"traces": [
{
"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>"
}
]
}Returns an array of traces in response to a user interaction.
curl --request POST \
--url https://general-runtime.voiceflow.com/v4/interact \
--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": {}
}
'{
"traces": [
{
"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>"
}
]
}Voiceflow API key
Send a launch request to start a new conversation.
Hide child attributes
audio Hide child attributes
Was this page helpful?