Skip to main content
POST
Create Detection Session

Authorizations

Authorization
string
header
required

Backend-issued machine access token for project-scoped API access.

Headers

Idempotency-Key
string | null

Body

application/json

Create-detection-session request payload.

mode
enum<string>
required

Runtime mode for the session.

Available options:
live,
replay
project_id
string<uuid>
required

Owning project identifier for the session.

contract_major
integer
default:1

Coupled public runtime contract major version requested by the client.

movespec_id
string<uuid> | null

Convenience MoveSpec identifier to resolve to the current released version.

movespec_version_id
string<uuid> | null

Explicit immutable MoveSpec version identifier.

Response

Successful Response

Session-creation response returned after admission succeeds.

input_schema_version
string
required

Negotiated public pose-frame schema version.

mode
enum<string>
required

Runtime mode for the session.

Available options:
live,
replay
output_schema_version
string
required

Negotiated public detection-event schema version.

project_id
string<uuid>
required

Bound customer project identifier.

resolved_movespec_version_id
string<uuid>
required

Immutable MoveSpec version selected for the session.

runtime_token
string
required

Session-scoped runtime JWT for websocket attach.

session_id
string<uuid>
required

Detection session identifier.

status
string
required

Initial lifecycle state.

Allowed value: "created"
stream_url
string
required

Stable public realtime websocket URL for the session.