Skip to main content
Read a hosted world session

Authorizations

Authorization
string
header
required

Opaque control credential

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
sessionId
string
required
Pattern: ^ses_[0-9a-z]{12,32}$

Response

Hosted world session

schemaVersion
enum<number>
required
Available options:
1
organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
environmentId
string
required
Pattern: ^env_[0-9a-z]{12,32}$
sessionId
string
required
Pattern: ^ses_[0-9a-z]{12,32}$
buildHash
string
required
Pattern: ^sha256:[0-9a-f]{64}$
seed
string
required
Required string length: 1 - 20
callbackReceiverBindingIds
string[]
required
Maximum array length: 64
Pattern: ^cbr_[0-9a-z]{12,32}$
state
enum<string>
required
Available options:
creating,
warming,
ready,
resetting,
degraded,
expired,
destroying,
destroyed
leaseGeneration
integer
required
Required range: 0 < x <= 9007199254740991
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
expiresAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
drillId
string

Run-ready setup from this drill. Mutually exclusive with scenarioId; omit both selectors for the build baseline.

Required string length: 1 - 96
Pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
scenarioId
string

Standalone setup from this compiled scenario, without a drill or target. Mutually exclusive with drillId.

Required string length: 1 - 96
Pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
warmPool
object

Explicitly reserved warm-world lineage. Only claimed worlds can become ready for agent access.

parentSessionId
string
Pattern: ^ses_[0-9a-z]{12,32}$
parentHostedSnapshotId
string
Pattern: ^hsnap_[0-9a-z]{12,32}$
destroyedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991