Rate this page:

ConversationalAIEvents

Constants

AgentResponse

Copy URL

Contains complete agent message. Sent with first audio chunk. Used for display and history. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#agent_response

Parameters

AgentResponseCorrection

Copy URL

Contains truncated response after interruption. Updates displayed message. Maintains conversation accuracy. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#agent_response_correction

Parameters

ClientToolCall

Copy URL

Represents a function call the agent wants the client to execute. Contains tool name, tool call ID, and parameters. Requires client-side execution of the function and sending the result back to the server. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#client_tool_call

Parameters

ContextualUpdate

Copy URL

Parameters

ConversationInitiationMetadata

Copy URL

Automatically sent when starting a conversation. Initializes conversation settings and parameters. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#conversation_initiation_metadata

Parameters

HTTPResponse

Copy URL

The HTTP response event.

Parameters

InternalTentativeAgentResponse

Copy URL

Parameters

Interruption

Copy URL

Parameters

Ping

Copy URL

Health check event requiring immediate response. Used to maintain WebSocket connection. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#ping

Parameters

Unknown

Copy URL

The unknown event.

Parameters

UserTranscript

Copy URL

Contains finalized speech-to-text results. Represents complete user utterances. Used for conversation history. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#user_transcript

Parameters

VadScore

Copy URL

Voice Activity Detection score event. Indicates the probability that the user is speaking. Values range from 0 to 1, where higher values indicate higher confidence of speech. https://elevenlabs.io/docs/conversational-ai/customization/events/client-events#vad_score

Parameters