Get conversation token

Get a WebRTC session token for real-time communication.

Headers

xi-api-keystringOptional

Query parameters

agent_idstringRequired

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

participant_namestringOptional
Optional custom participant name. If not provided, user ID will be used
branch_idstringOptional
The ID of the branch to use
environmentstringOptional

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

Response

Successful Response
tokenstring

Errors

422
Conversations Get Webrtc Token Request Unprocessable Entity Error