Skip to main content
POST
Create Embed Session

Authorizations

Authorization
string
header
required

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

Body

application/json

Request to mint a short-lived embed session token.

end_user_ref
string | null

Opaque, audit-only reference to your end user. Not used for data filtering.

Maximum string length: 256
ttl_seconds
integer | null

Requested token lifetime in seconds; capped at the server maximum.

Required range: x > 0

Response

Successful Response

A minted embed session token.

token
string
required
expires_at
string<date-time>
required
expires_in
integer
required