Przejdź do nawigacji
Dokumentacja API

Agent WebSockets

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

Uzgadnianie

WSS
/v1/convai/conversation

Parametry zapytania

agent_idstringWymagany
The unique identifier of the agent to converse with.

Wyślij

User Audio ChunkobjectWymagany
Send audio data chunks from the user to the server for processing.
OR
FeedbackobjectWymagany
Feedback score for a specific agent response event.
OR
User MessageobjectWymagany
Text message sent by the user to the conversation.
OR
User ActivityobjectWymagany
Activity ping to prevent agent interruption and indicate user presence.
OR
Multimodal MessageobjectWymagany
A message combining text and file references, sent by the user to the conversation.
OR
PongobjectWymagany
Response message to server ping requests for latency measurement.
OR
Client Tool ResultobjectWymagany

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

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

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

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

Odbierz

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

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 CallobjectWymagany

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

OR
Client ErrorobjectWymagany
Error event sent when an error occurs during the conversation.
OR
Guardrail TriggeredobjectWymagany
Notification that a guardrail was triggered during the conversation.
OR
User TranscriptobjectWymagany

Real-time transcriptions of user speech input.

OR
Agent ResponseobjectWymagany
Text responses generated by the AI agent.
OR
Queue StatusobjectWymagany

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

OR
Agent Response CorrectionobjectWymagany
Correction to a previous agent response.
OR
Agent Response MetadataobjectWymagany
Metadata associated with an agent response, such as custom LLM response metadata.
OR
Audio ResponseobjectWymagany
Synthesized audio chunks of the agent's speech response.
OR
InterruptionobjectWymagany
Notification that the agent's current response was interrupted.
OR
VAD ScoreobjectWymagany
Voice Activity Detection scoring information.
OR
Agent Chat Response PartobjectWymagany
Streaming text chunks of an agent's chat response.
OR
Client Tool CallobjectWymagany
Requests from server for client to execute specific tool functions.
OR
Agent Tool ResponseobjectWymagany
Response from an agent tool execution including status and metadata.
OR
Agent Tool Response Full PayloadobjectWymagany
Tool response including the tool's full result payload as a string.
OR
Agent Tool RequestobjectWymagany
Notification that the agent is requesting a tool to be executed.
OR
PingobjectWymagany

Server-initiated ping messages for measuring connection latency.

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