Zur Navigation springen

Agent WebSockets

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

Handshake

WSS
/v1/convai/conversation

Abfrageparameter

agent_idstringErforderlich
The unique identifier of the agent to converse with.

Senden

User Audio ChunkobjectErforderlich
Send audio data chunks from the user to the server for processing.
OR
FeedbackobjectErforderlich
Feedback score for a specific agent response event.
OR
User MessageobjectErforderlich
Text message sent by the user to the conversation.
OR
User ActivityobjectErforderlich
Activity ping to prevent agent interruption and indicate user presence.
OR
Multimodal MessageobjectErforderlich
A message combining text and file references, sent by the user to the conversation.
OR
PongobjectErforderlich
Response message to server ping requests for latency measurement.
OR
Client Tool ResultobjectErforderlich

Results from client-side tool execution requested by the server.

OR
Mcp Tool Approval ResultobjectErforderlich
User approval or rejection of an MCP tool call that requires confirmation.
OR
Contextual UpdateobjectErforderlich

Non-interrupting content sent to update the conversation state without disrupting the flow.

OR
Conversation Initiation Client DataobjectErforderlich
Client configuration data to override default conversation settings.

Empfangen

Conversation Initiation MetadataobjectErforderlich
Initial metadata and configuration details for a new conversation, only sent once.
OR
Agent Response CompleteobjectErforderlich
Notification that the agent has finished generating a complete response.
OR
Context UsageobjectErforderlich

Current LLM context-window usage, emitted after each completed agent turn. Reports the prompt size of the turn’s final LLM generation together with the model’s context limit.

OR
Mcp Tool CallobjectErforderlich

MCP tool call event with state updates (loading, awaiting_approval, success, failure).

OR
Client ErrorobjectErforderlich
Error event sent when an error occurs during the conversation.
OR
Guardrail TriggeredobjectErforderlich
Notification that a guardrail was triggered during the conversation.
OR
User TranscriptobjectErforderlich

Real-time transcriptions of user speech input.

OR
Agent ResponseobjectErforderlich
Text responses generated by the AI agent.
OR
Queue StatusobjectErforderlich

Wait-queue status for a caller held at the concurrency limit: waiting, admitted, or timed_out.

OR
Agent Response CorrectionobjectErforderlich
Correction to a previous agent response.
OR
Agent Response MetadataobjectErforderlich
Metadata associated with an agent response, such as custom LLM response metadata.
OR
Audio ResponseobjectErforderlich
Synthesized audio chunks of the agent's speech response.
OR
InterruptionobjectErforderlich
Notification that the agent's current response was interrupted.
OR
VAD ScoreobjectErforderlich
Voice Activity Detection scoring information.
OR
Agent Chat Response PartobjectErforderlich
Streaming text chunks of an agent's chat response.
OR
Client Tool CallobjectErforderlich
Requests from server for client to execute specific tool functions.
OR
Agent Tool ResponseobjectErforderlich
Response from an agent tool execution including status and metadata.
OR
Agent Tool Response Full PayloadobjectErforderlich
Tool response including the tool's full result payload as a string.
OR
Agent Tool RequestobjectErforderlich
Notification that the agent is requesting a tool to be executed.
OR
PingobjectErforderlich

Server-initiated ping messages for measuring connection latency.

OR
Mcp Connection StatusobjectErforderlich
MCP connection status update with integration connection states.