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_namestring or nullOptional
Optional custom participant name. If not provided, user ID will be used
branch_idstring or nullOptional
The ID of the branch to use
environmentstring or nullOptional

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

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

Response

Successful Response
tokenstring
conversation_idstring

Errors

422
Unprocessable Entity Error