Agents Platform

Get Webrtc Token

Changed on

Get a WebRTC session token for real-time communication.

get/v1/convai/conversation/token

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/conversation/token
  • Auth
    none declared

Query parameters

agent_idstring required

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz
participant_namestring nullable

Optional custom participant name. If not provided, user ID will be used

branch_idstring nullable

The ID of the branch to use

version_idstring nullable

The ID of the version to use

environmentstring nullable

The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'.

debug_events_requestboolean

Whether to enable debug events. Only available for users with editor access to the agent.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

tokenstring required
conversation_idstring required

Changes