Agent WebSockets

Establish a WebSocket connection for real-time conversations with an AI agent.

HandshakeTry it

GET

Query parameters

agent_idstringRequired

The unique identifier for the voice to use in the TTS process.

Send

User Audio ChunkobjectRequired
OR
PongobjectRequired
OR
Conversation Initiation Client DataobjectRequired
OR
Client Tool ResultobjectRequired
OR
Contextual UpdateobjectRequired

Receive

Conversation Initiation MetadataobjectRequired
OR
User TranscriptobjectRequired
OR
Agent ResponseobjectRequired
OR
Agent Response CorrectionobjectRequired
OR
Audio ResponseobjectRequired
OR
InterruptionobjectRequired
OR
PingobjectRequired
OR
Client Tool CallobjectRequired
OR
Contextual UpdateobjectRequired
OR
Internal Vad ScoreobjectRequired
OR
Internal Turn ProbabilityobjectRequired
OR
Internal Tentative Agent ResponseobjectRequired