Skip to main content
POST
Create a session

Authorizations

Authorization
string
header
required

A server-side Digital Human API key.

Headers

Idempotency-Key
string
required

A caller-generated identifier for this logical create operation.

Required string length: 1 - 200

Body

application/json
participant_identity
string

Identity assigned to the browser participant.

Required string length: 1 - 100
digital_human_id
string<uuid>

Digital human to join the session.

tags
string[]
Maximum array length: 20
metadata
object

Response

Session created

id
string<uuid>
required
status
enum<string>
required
Available options:
created,
active,
completed,
failed,
cancelled
room_name
string
required
livekit_url
string<uri>
required
participant_token
string | null
required

Short-lived room token. Null after the session becomes terminal.

created_at
string<date-time>
required
started_at
string<date-time> | null
required
ended_at
string<date-time> | null
required