Skip to main content
POST
Check out a version

Authorizations

Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).

Headers

If-Match
string

The rev you read; checkout returns 409 if it is stale (optimistic concurrency).

Path Parameters

id
string<uuid>
required

Body

application/json
versionId
string<uuid>
required
expectedRev
string

Alternative to the If-Match header for optimistic concurrency.

Response

World checked out

world
object

A playable world's compiled graph, id, name, entrance, and the scene (states + events). This is the shape returned inside the world field of a World resource (see World) and by the graph-editing routes. Additional optional properties are allowed (forward-compatible); the schemaVersion on responses pins the contract version.

rev
string