Skip to main content
POST
/
v4
/
interact
/
stream
Interact v4 (stream)
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"
}

Authorizations

authorization
string
header
required

Voiceflow API key

Body

application/json
action
object
required

Send a launch request to start a new conversation.

variables
object
state
any
config
object

Response

200 - text/event-stream

Traces contain responses, media and metadata generated by the conversation runtime.

event
enum<string>
required
Available options:
trace
data
object
required
id
string
type
enum<string>
Available options:
event