Skip to main content
POST
Mint an embed session

Authorizations

Authorization
string
header
required

Project API key (ck_live_… or ck_test_…) presented as a bearer token. For embed partner endpoints this is the partner secret key, which is the same credential type.

Body

application/json
tenant
object
required
actor
object
required
scope
object
variableCatalog
object
catalogRef
object
permissions
object
permissionsPreset
string
Maximum string length: 60
branding
object
appearance
object
callbacks
object
limits
object
form
object

Form-fill claims; only meaningful when scope.mode === 'fill'.

Response

Session minted.

snake_case response from session mint/refresh.

session_id
string<uuid>
required
session_token
string
required
iframe_url
string<uri>
required
expires_at
string<date-time>
required
renew_token
string
required