Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

agentId
string<uuid>
required

Body

application/json
modality
enum<string>
required

voice or chat. The agent must have that modality turned on.

Available options:
voice,
chat,
call
Example:

"voice"

channel
string
required

How it is reached. web: in a browser on one of allowedOrigins, joined with the web SDK.

Allowed value: "web"
allowedOrigins
string[]
required

The origins your page may join from, exactly as the browser sends them: https only (http on localhost for development), no paths or wildcards.

Required array length: 1 - 10 elements
Required string length: 1 - 255
Example:
clientTokenTtlSeconds
integer

How long the browser has to join, in seconds. Default 120.

Required range: 30 <= x <= 600
Example:

120

Response

The conversation, waiting for the browser to join.

data
object
required