IOionworks
Simulations

Create Simulation Batch With Template

Changed on

Optimized batch simulation creation with template-based experiments.

This endpoint is for creating multiple simulations using template-based experiments with DOE support. For protocol-based batch simulations, use POST /simulations/batch.

Returns

List[SimulationCreationResponse] List of simulation creation responses with IDs, job info, and status

Raises

HTTPException If usage limit reached or job submission fails

post/simulations/with-template/batch

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/simulations/with-template/batch
  • Auth
    none declared

Request body

experiment_template_idstring required
experiment_parameter_setsobject[] nullable
experiment_conditionsobject[] nullable
study_idstring nullable
project_idstring nullable
max_backward_jumpsinteger nullable
extra_variablesstring[] nullable
variable_callback_rulesobject[] nullable
termination_condition_rulesobject[] nullable
treat_pause_as_restboolean nullable
simulation_settingsobject nullable
force_rerunboolean

Response

Successful Response

simulation_idstring required
job_idstring required
already_existedboolean

True when an identical run (same model, protocol inputs, design and options) already existed and its job was reused, finished or still running; nothing new was started.

Changes