Get conversation token

Get a WebRTC session token for real-time communication.

ヘッダー

xi-api-keystringオプション

クエリパラメータ

agent_idstring必須

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

participant_namestringオプション
Optional custom participant name. If not provided, user ID will be used
branch_idstringオプション
The ID of the branch to use
version_idstringオプション
The ID of the version to use
environmentstringオプション

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

debug_events_requestbooleanオプションデフォルト値 false
Whether to enable debug events. Only available for users with editor access to the agent.

レスポンス

Successful Response
tokenstring
conversation_idstring

エラー

422
Conversations Get Webrtc Token Request Unprocessable Entity Error