Skip to main content
POST
Create web session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required

Voice agent ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
arguments
object

Per-session template argument overrides. Maximum 32 keys. Each value may be up to 1024 characters. Combined value payload may not exceed 8192 characters.

participant_name
string | null

Optional display name for the web participant.

Response

Web session created.

call_id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

room_name
string
required

Internal session identifier for advanced browser integrations.

livekit_url
string
required

Browser session transport URL.

livekit_token
string
required

Browser session access token.

max_session_seconds
integer
required
Required range: x >= 60
message
string
required
Example:

"Web session created successfully"