Skip to main content
GET
Get Webrtc Token

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Query Parameters

agent_id
string
required

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

Examples:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

"seng_3701k3ttaq12ewp8b7qv5rfyszkz"

participant_name
string | null

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

branch_id
string | null

The ID of the branch to use

environment
string | null

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

debug_events_request
boolean
default:false

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

Response

Successful Response

token
string
required
conversation_id
string
required