Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
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

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

branch_idstring nullable

The ID of the branch to use

The ID of the branch to use

environmentstring nullable

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

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

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.

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