Skip to main content
POST
Cancel World Build

Authorizations

Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Path Parameters

id
string
required

World ID.

Pattern: ^wld_[0-9A-HJKMNP-TV-Z]{26}$

Response

OK

active_advance_id
string | null
required

Current clock advance operation ID, or null.

Pattern: ^adv_[0-9A-HJKMNP-TV-Z]{26}$
active_change_id
string | null
required

Current membership change ID, or null.

Pattern: ^wch_[0-9A-HJKMNP-TV-Z]{26}$
build
object | null
required

The build's latest progress report and verified starting data, or null before the first report.

created_at
string<date-time>
required

World creation time.

current_time
string<date-time>
required

Target of the last settled World clock request. Individual member clocks can differ.

error
object | null
required

Safe failure information, or null when no failure exists.

id
string
required

World ID.

Pattern: ^wld_[0-9A-HJKMNP-TV-Z]{26}$
instructions
string
required

Instructions for the initial synthetic data and relationships, or empty when none were given.

metadata
any
required

Customer JSON metadata, or null.

name
string
required

World name. The ID is its identity, and names need not be unique.

Maximum string length: 128
simulations
object[]
required

Created member Simulations. This list is empty before first start.

simulators
string[]
required

Simulator IDs in member order.

Pattern: ^smr_[0-9A-HJKMNP-TV-Z]{26}$
start_time
string<date-time>
required

Simulated time the World starts at: chosen at build, and changeable on the first Start.

status
enum<string>
required

pending while waiting for capacity; building while the build runs; ready when it can be started; running or stopped once its Simulations exist; failed when building or first start fails; canceled when the build was canceled.

Available options:
pending,
building,
ready,
running,
stopped,
failed,
canceled