---
title: "Create Simulation Batch With Template"
method: POST
path: "/simulations/with-template/batch"
tags: ["Simulations"]
---

# Create Simulation Batch With Template

`POST /simulations/with-template/batch`

## Request

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

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

## Request body

- CreateSimulationBatchBody: Request body for creating multiple simulations with single model/template.
  - `parameterized_model` union, required
    - object
    - string
  - `experiment_template_id` string, required
  - `conditions` BatchCondition[], nullable
    - `experiment_parameters` object
    - `design_parameters` object
  - `experiment_parameter_sets` object[], nullable
  - `experiment_conditions` object[], nullable
  - `design_parameters_doe` DOERequest: 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.
    - `sampling` string
    - `rows` union[]
      - union
        - DiscreteParam: Discrete parameter configuration. Parameters ---------- name Parameter name. values List of allowed numeric values.
          - `type` 'discrete'
          - `name` string, required
          - `values` number[]
        - RangeParam: Range parameter configuration. Parameters ---------- name Parameter name. min Minimum value (inclusive). max Maximum value (inclusive). count Optional grid sample count for this parameter. Required for ``grid`` sampling; ignored for non-grid methods.
          - `type` 'range'
          - `name` string, required
          - `min` number, required
          - `max` number, required
          - `count` integer, nullable
        - NormalParam: Normal parameter configuration. Parameters ---------- name Parameter name. mean Mean of the distribution. std Standard deviation of the distribution. count Optional grid sample count for this parameter. Required for ``grid`` sampling; ignored for non-grid methods.
          - `type` 'normal'
          - `name` string, required
          - `mean` number, required
          - `std` number, required
          - `count` integer, nullable
    - `count` integer, nullable
  - `study_id` string, nullable
  - `project_id` string, nullable
  - `max_backward_jumps` integer, nullable
  - `extra_variables` string[], nullable
  - `variable_callback_rules` object[], nullable
  - `termination_condition_rules` object[], nullable
  - `treat_pause_as_rest` boolean, nullable
  - `simulation_settings` object, nullable
  - `force_rerun` boolean

## Response `202`

Successful Response

- SimulationCreationResponse[]
  - `simulation_id` string, required
  - `job_id` string, required
  - `already_existed` boolean: 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.

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-28** `3abf50e2d741`: 1 info
  - added the new optional request property `simulation_settings`
- **2026-10-24** `f4c74e855466`: 1 info
  - added the optional property `items/already_existed` to the response with the `202` status

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/simulations/with-template/batch/post.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)