A trace describes an agent message, control instruction, audio output or execution event. Dispatch on trace.type, then read the matching payload definition below.
- Chat delivery: Streaming responses defines SSE framing and the non-streaming JSON alternative.
- Voice delivery: Playback and interruptions explains Socket.IO output and audio acknowledgements.
Completion signals
A socket disconnection is a connection interruption, not a conversation-end signal. See Voice connection recovery before retrying an interrupted turn.
Trace types
Select a type for its payload fields and handling guidance.
Messages and UI
Voice and telephony
Conversation control
Events and diagnostics
Custom actions
Additional trace types
Choice traces can contain path buttons or buttons generated by the agent. Their next-action payloads differ:
Path buttons
See Choice: Path buttons.
Agent-generated buttons
See Choice: Agent-generated buttons.
Completion event traces
Set config.completionEvents to true on a Chat Streaming request or in Voice’s client.start configuration to receive generated-text chunks. A completion trace uses payload.state values of start, content and end; the end state finishes that generation, not the conversation.
Use payload.messageID to associate chunks with their message. See the completion payload reference for the fields present in each state and Sending actions for request configuration.