List Simulations

List simulations filtered by either a parameterized model or a study.

Exactly one of parameterized_model_id or study_id must be provided. Returns simulation summaries without simulation_data, plus a map of model scalar parameters deduplicated by parameterized_model_id.

Parameters

parameterized_model_id : str, optional Filter simulations belonging to this parameterized model. study_id : str, optional Filter simulations assigned to this study. limit : int, optional Maximum number of results to return. Must be between 1 and 1000. Defaults to 100. offset : int, optional Number of results to skip for pagination. Must be >= 0. Defaults to 0.

Returns

ListSimulationsResponse Simulations, model scalar parameters map, and total count.

List Simulations

cURL

curl --request GET \
  --url https://api.ionworks.com/simulations

200

{
  "simulations": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "experiment_id": "<string>",
      "parameterized_model_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "design_id": "<string>",
      "job_id": "<string>",
      "status": "<string>",
      "error": "<string>",
      "error_code": "<string>",
      "metrics": {},
      "storage_folder": "<string>",
      "organization_id": "<string>",
      "experiment": {},
      "parameterized_model": {},
      "design": {}
    }
  ],
  "model_scalar_parameters": {},
  "total": 0
}

Query Parameters

parameterized_model_id · string | null

study_id · string | null

limit · integer · default: 100

Required range: 1 <= x <= 1000

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

Successful Response

Response for study simulations with deduplicated model parameters.

Instead of including full parameters on each simulation (which can be massive expression trees), this response includes simulations without parameters and a separate map of model_id -> scalar parameters. The frontend can merge: design.design_parameters over model base params.

simulations · SimulationSummary · object[] · required

List of simulation summaries without full parameters

Show child attributes

model_scalar_parameters · Model Scalar Parameters · object

Map of parameterized_model_id to scalar-only parameters. Used as fallback when design.design_parameters doesn't have a value.

Show child attributes

total · integer · default: 0

Total number of matching simulations.