Agents Platform

Get Webrtc Token

Get a WebRTC session token for real-time communication.

get/v1/convai/conversation/token

Query parameters

agent_idstring required

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

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

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

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

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

Changed in 2 of the 28 revisions of this API.2

Aug 20, 2026db6eec599cbe1See the full diff
- ○
  added the new optional query request parameter debug_events_request
  new-optional-request-parameter
Jul 26, 2026494d96419d151See the full diff
- ○
  added the required property conversation_id to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history