Start World
Starts every Simulation in the World. The first start creates the Simulations; later starts restore them from saved state. The World must be ready or stopped, and the workspace must have room for all members under its active-Simulation limit. A running World is returned unchanged.
Authorizations
Use a Continuous API key. Send it in the Authorization header as a Bearer token.
Path Parameters
World ID.
^wld_[0-9A-HJKMNP-TV-Z]{26}$Body
Simulated time for the first Start, in RFC 3339 format. Omission keeps the clock chosen at build. Saved business dates remain unchanged. Later starts preserve the clock.
Response
OK
Current clock advance operation ID, or null.
^adv_[0-9A-HJKMNP-TV-Z]{26}$Current membership change ID, or null.
^wch_[0-9A-HJKMNP-TV-Z]{26}$The build's latest progress report and verified starting data, or null before the first report.
World creation time.
Target of the last settled World clock request. Individual member clocks can differ.
Safe failure information, or null when no failure exists.
World ID.
^wld_[0-9A-HJKMNP-TV-Z]{26}$Instructions for the initial synthetic data and relationships, or empty when none were given.
Customer JSON metadata, or null.
World name. The ID is its identity, and names need not be unique.
128Created member Simulations. This list is empty before first start.
Simulator IDs in member order.
^smr_[0-9A-HJKMNP-TV-Z]{26}$Simulated time the World starts at: chosen at build, and changeable on the first Start.
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.
pending, building, ready, running, stopped, failed, canceled