Vai alla navigazione
Per iniziare

Agent WebSockets

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

Handshake

WSS
/v1/convai/conversation

Parametri di query

agent_idstringObbligatorio
The unique identifier of the agent to converse with.

Invia

User Audio ChunkobjectObbligatorio
Send audio data chunks from the user to the server for processing.
OR
FeedbackobjectObbligatorio
Feedback score for a specific agent response event.
OR
User MessageobjectObbligatorio
Text message sent by the user to the conversation.
OR
User ActivityobjectObbligatorio
Activity ping to prevent agent interruption and indicate user presence.
OR
Multimodal MessageobjectObbligatorio
A message combining text and file references, sent by the user to the conversation.
OR
PongobjectObbligatorio
Response message to server ping requests for latency measurement.
OR
Client Tool ResultobjectObbligatorio

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

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

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

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

Ricevi

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

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 CallobjectObbligatorio

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

OR
Client ErrorobjectObbligatorio
Error event sent when an error occurs during the conversation.
OR
Guardrail TriggeredobjectObbligatorio
Notification that a guardrail was triggered during the conversation.
OR
User TranscriptobjectObbligatorio

Real-time transcriptions of user speech input.

OR
Agent ResponseobjectObbligatorio
Text responses generated by the AI agent.
OR
Queue StatusobjectObbligatorio

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

OR
Agent Response CorrectionobjectObbligatorio
Correction to a previous agent response.
OR
Agent Response MetadataobjectObbligatorio
Metadata associated with an agent response, such as custom LLM response metadata.
OR
Audio ResponseobjectObbligatorio
Synthesized audio chunks of the agent's speech response.
OR
InterruptionobjectObbligatorio
Notification that the agent's current response was interrupted.
OR
VAD ScoreobjectObbligatorio
Voice Activity Detection scoring information.
OR
Agent Chat Response PartobjectObbligatorio
Streaming text chunks of an agent's chat response.
OR
Client Tool CallobjectObbligatorio
Requests from server for client to execute specific tool functions.
OR
Agent Tool ResponseobjectObbligatorio
Response from an agent tool execution including status and metadata.
OR
Agent Tool Response Full PayloadobjectObbligatorio
Tool response including the tool's full result payload as a string.
OR
Agent Tool RequestobjectObbligatorio
Notification that the agent is requesting a tool to be executed.
OR
PingobjectObbligatorio

Server-initiated ping messages for measuring connection latency.

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