Skip to main content
POST
SDK

Authorizations

Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
label
string | null

Human-readable label persisted on the session record.

keepAliveMs
integer

Keep-alive duration in milliseconds. Capped server-side at 1 hour.

Response

Session opened

id
string
required
organizationId
string
required
status
enum<string>
required
Available options:
active,
closed,
expired
browserMsUsed
integer
required
commandCount
integer
required
keepAliveMs
integer
required
lastUsedAt
string<date-time>
required
createdAt
string<date-time>
required
apiTokenId
string | null
label
string | null
closedAt
string<date-time> | null