Skip to main content
Get Simulation

Path Parameters

simulation_id
string<uuid>
required

Query Parameters

summary
boolean
default:false

Return the run's status, model, protocol and inputs without its resolved parameters or simulation data.

Response

Successful Response

id
string
required

The unique identifier for the simulation.

created_at
string<date-time>
required

Timestamp of when the simulation was created.

experiment_id
string
required

The ID of the experiment this simulation belongs to.

parameterized_model_id
string
required

The ID of the parameterized model used for this simulation.

organization_id
string
required

Organization this simulation belongs to.

url
string | null
api_url
string | null
updated_at
string<date-time> | null

Timestamp of when the simulation was last updated.

project_id
string | null

The project the simulation belongs to: its experiment's project.

design_id
string | null

The ID of the design for this simulation.

job_id
string | null

The ID of the job running this simulation.

status
string | null

The current status of the job running this simulation.

error
string | null

Error message if the job failed.

error_code
string | null

Machine-readable error code.

metrics
Metrics · object | null

Computed metrics from the simulation.

simulation_options
Simulation Options · object | null

Options the simulation was run with; part of its identity, so a rerun must send them back.

storage_folder
string | null

Folder path in storage containing simulation files (solution.parquet, time_series.parquet, steps.parquet).

experiment
Experiment · object | null

The experiment this simulation belongs to (id and template).

parameterized_model
Parameterized Model · object | null

The parameterized model (id and name only).

design
Design · object | null

The design used for this simulation.

protocol_id
string | null

The saved protocol (experiment template) the simulation ran; the same id the run and list endpoints take as a protocol.

protocol_name
string | null

That protocol's name.

parameters
Parameters · object | null

Resolved parameters for the simulation.

simulation_data
Simulation Data · object | null

The data from the simulation (time_series, steps).