Skip to main content
POST
Create session

Authorizations

Authorization
string
header
required

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

Body

application/json
agent_id
string
required

Agent to run.

call_type
enum<string>
default:web
Available options:
web,
outbound_phone
phone_number
string

E.164 number to dial for outbound_phone.

participant_identity
string

Defaults to the auth user id.

participant_name
string

Defaults to the logged-in user's name.

custom_variables
object

Values substituted into the agent's prompt.

config
object

Per-session provider overrides.

metadata
object

Client metadata (trusted ids are server-stamped).

Response

Created session with participant token (the only place the token is returned)