API referenceConversations

Get conversation token

Get a WebRTC session token for real-time communication.

Headers

xi-api-keystringOptional

Query parameters

agent_idstringRequired
The id of the agent you're taking the action on.
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’.

Response

Successful Response
tokenstring

Errors

422
Unprocessable Entity Error