Skip to main content
POST
Start Simulation

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

Simulation ID.

Pattern: ^sim_[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}$
created_at
string<date-time>
required

Simulation creation time.

current_time
string<date-time>
required

Current simulated time.

endpoint
string<uri>
required

Base URL for requests to the Simulation. For a Simulation in your own runtime environment it is that environment's proxy, and the Continuous /sim/{id} URL answers 421 simulation_endpoint_external.

endpoint_external
boolean
required

True when the endpoint is your own runtime environment's proxy rather than Continuous's, so a client calls it directly.

expires_at
string<date-time> | null
required
deprecated

Always null; Simulation tokens do not expire. Deprecated; will be removed.

id
string
required

Simulation ID.

Pattern: ^sim_[0-9A-HJKMNP-TV-Z]{26}$
include_sample_data
boolean
required

Whether the Simulation started with the Simulator's sample data. A fork inherits its source's state and reports false.

metadata
any
required

Customer JSON metadata, or null.

name
string
required

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

Maximum string length: 128
parent_id
string | null
required

Source Simulation ID for a fork, or null.

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

OCI manifest digest pinned when the Simulation was created.

Pattern: ^sha256:[0-9a-f]{64}$
simulator_id
string
required

ID of the Simulator bound to this Simulation.

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

Initial simulated time.

status
enum<string>
required

Current status. running serves requests. paused means the Simulation was idle and the platform paused it; the next request wakes it. stopped means its state is saved and requests return 409 until you start it.

Available options:
running,
paused,
stopped
token
string
required

The Simulation's token for requests to its endpoint. It does not expire. Send it in the X-Continuous-Simulation-Token header, with an actor's id from GET /v1/simulations/{id} in X-Continuous-Actor to act as that caller. Retrieve it later with GET /v1/simulations/{id}/token.

Minimum string length: 1