Data channel for exchanging session control messages and metadata between the client and server, including session state changes, errors, and transcript data.
Client-initiated control message for managing session behavior.
Content-Type: application/json
SessionStateEvent
Server-sent event indicating a change in session state.
Content-Type: application/json
TranscriptEvent
Server-sent event containing transcript data from the conversation, including both user speech and avatar responses.
Content-Type: application/json
SessionErrorEvent
Server-sent event indicating an error occurred during the session.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.