ナビゲーションにスキップ

Agent WebSockets

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

ハンドシェイク

WSS
/v1/convai/conversation

クエリパラメータ

agent_idstring必須
The unique identifier of the agent to converse with.

送信

User Audio Chunkobject必須
Send audio data chunks from the user to the server for processing.
OR
Feedbackobject必須
Feedback score for a specific agent response event.
OR
User Messageobject必須
Text message sent by the user to the conversation.
OR
User Activityobject必須
Activity ping to prevent agent interruption and indicate user presence.
OR
Multimodal Messageobject必須
A message combining text and file references, sent by the user to the conversation.
OR
Pongobject必須
Response message to server ping requests for latency measurement.
OR
Client Tool Resultobject必須

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

OR
Mcp Tool Approval Resultobject必須
User approval or rejection of an MCP tool call that requires confirmation.
OR
Contextual Updateobject必須

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

OR
Conversation Initiation Client Dataobject必須
Client configuration data to override default conversation settings.

受信

Conversation Initiation Metadataobject必須
Initial metadata and configuration details for a new conversation, only sent once.
OR
Agent Response Completeobject必須
Notification that the agent has finished generating a complete response.
OR
Context Usageobject必須

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 Callobject必須

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

OR
Client Errorobject必須
Error event sent when an error occurs during the conversation.
OR
Guardrail Triggeredobject必須
Notification that a guardrail was triggered during the conversation.
OR
User Transcriptobject必須

Real-time transcriptions of user speech input.

OR
Agent Responseobject必須
Text responses generated by the AI agent.
OR
Queue Statusobject必須

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

OR
Agent Response Correctionobject必須
Correction to a previous agent response.
OR
Agent Response Metadataobject必須
Metadata associated with an agent response, such as custom LLM response metadata.
OR
Audio Responseobject必須
Synthesized audio chunks of the agent's speech response.
OR
Interruptionobject必須
Notification that the agent's current response was interrupted.
OR
VAD Scoreobject必須
Voice Activity Detection scoring information.
OR
Agent Chat Response Partobject必須
Streaming text chunks of an agent's chat response.
OR
Client Tool Callobject必須
Requests from server for client to execute specific tool functions.
OR
Agent Tool Responseobject必須
Response from an agent tool execution including status and metadata.
OR
Agent Tool Response Full Payloadobject必須
Tool response including the tool's full result payload as a string.
OR
Agent Tool Requestobject必須
Notification that the agent is requesting a tool to be executed.
OR
Pingobject必須

Server-initiated ping messages for measuring connection latency.

OR
Mcp Connection Statusobject必須
MCP connection status update with integration connection states.