Ir para a navegação
Começar

Agent WebSockets

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

Handshake

WSS
/v1/convai/conversation

Parâmetros de consulta

agent_idstringObrigatório
The unique identifier of the agent to converse with.

Enviar

User Audio ChunkobjectObrigatório
Send audio data chunks from the user to the server for processing.
OR
FeedbackobjectObrigatório
Feedback score for a specific agent response event.
OR
User MessageobjectObrigatório
Text message sent by the user to the conversation.
OR
User ActivityobjectObrigatório
Activity ping to prevent agent interruption and indicate user presence.
OR
Multimodal MessageobjectObrigatório
A message combining text and file references, sent by the user to the conversation.
OR
PongobjectObrigatório
Response message to server ping requests for latency measurement.
OR
Client Tool ResultobjectObrigatório

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

OR
Mcp Tool Approval ResultobjectObrigatório
User approval or rejection of an MCP tool call that requires confirmation.
OR
Contextual UpdateobjectObrigatório

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

OR
Conversation Initiation Client DataobjectObrigatório
Client configuration data to override default conversation settings.

Receber

Conversation Initiation MetadataobjectObrigatório
Initial metadata and configuration details for a new conversation, only sent once.
OR
Agent Response CompleteobjectObrigatório
Notification that the agent has finished generating a complete response.
OR
Context UsageobjectObrigatório

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 CallobjectObrigatório

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

OR
Client ErrorobjectObrigatório
Error event sent when an error occurs during the conversation.
OR
Guardrail TriggeredobjectObrigatório
Notification that a guardrail was triggered during the conversation.
OR
User TranscriptobjectObrigatório

Real-time transcriptions of user speech input.

OR
Agent ResponseobjectObrigatório
Text responses generated by the AI agent.
OR
Queue StatusobjectObrigatório

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

OR
Agent Response CorrectionobjectObrigatório
Correction to a previous agent response.
OR
Agent Response MetadataobjectObrigatório
Metadata associated with an agent response, such as custom LLM response metadata.
OR
Audio ResponseobjectObrigatório
Synthesized audio chunks of the agent's speech response.
OR
InterruptionobjectObrigatório
Notification that the agent's current response was interrupted.
OR
VAD ScoreobjectObrigatório
Voice Activity Detection scoring information.
OR
Agent Chat Response PartobjectObrigatório
Streaming text chunks of an agent's chat response.
OR
Client Tool CallobjectObrigatório
Requests from server for client to execute specific tool functions.
OR
Agent Tool ResponseobjectObrigatório
Response from an agent tool execution including status and metadata.
OR
Agent Tool Response Full PayloadobjectObrigatório
Tool response including the tool's full result payload as a string.
OR
Agent Tool RequestobjectObrigatório
Notification that the agent is requesting a tool to be executed.
OR
PingobjectObrigatório

Server-initiated ping messages for measuring connection latency.

OR
Mcp Connection StatusobjectObrigatório
MCP connection status update with integration connection states.