Skip to main content
Create Simulation Batch With Template
curl --request POST \
  --url https://api.ionworks.com/simulations/with-template/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "parameterized_model": {},
  "experiment_template_id": "<string>",
  "conditions": [
    {
      "experiment_parameters": {},
      "design_parameters": {}
    }
  ],
  "experiment_parameter_sets": [
    {}
  ],
  "experiment_conditions": [
    {}
  ],
  "design_parameters_doe": {
    "sampling": "grid",
    "rows": [
      {
        "name": "<string>",
        "type": "discrete",
        "values": [
          123
        ]
      }
    ],
    "count": 123
  },
  "study_id": "<string>",
  "max_backward_jumps": 123,
  "extra_variables": [
    "<string>"
  ],
  "variable_callback_rules": [
    {}
  ],
  "termination_condition_rules": [
    {}
  ],
  "force_rerun": false
}
'
[
  {
    "simulation_id": "<string>",
    "job_id": "<string>"
  }
]

Body

application/json

Request body for creating multiple simulations with single model/template.

parameterized_model
required
experiment_template_id
string
required
conditions
BatchCondition · object[] | null
experiment_parameter_sets
Experiment Parameter Sets · object[] | null
experiment_conditions
Experiment Conditions · object[] | null
design_parameters_doe
DOERequest · object

Design of Experiments request with rows.

Parameters

sampling Sampling strategy. Supported: grid (cartesian product). rows List of parameter rows; each carries its own type and config fields. count Number of samples for non-grid methods (required). Ignored for grid sampling.

study_id
string | null
max_backward_jumps
integer | null
extra_variables
string[] | null
variable_callback_rules
Variable Callback Rules · object[] | null
termination_condition_rules
Termination Condition Rules · object[] | null
force_rerun
boolean
default:false

Response

Successful Response

simulation_id
string
required
job_id
string
required