Create Protocol Simulation Batch

Create multiple protocol-based simulations (batch).

This endpoint creates multiple simulations using the Universal Cycler Protocol format with optional Design of Experiments (DOE) support for generating parameter variations.

For template-based batch simulations, use POST /simulations/with-template/batch.

Parameters

user_org_client : Tuple[str, str, Client] Current user_id, organization_id, and client usage_service : UsageService Usage tracking service experiment_service : ExperimentService Experiment service for business logic parameterized_models_repository : ParameterizedModelsRepository Parameterized models repository experiment_template_repository : ExperimentTemplateRepository Experiment template repository service_experiment_template_repository : ExperimentTemplateRepository Service experiment template repository study_mapping_repository : StudySimulationMappingRepository Study-simulation mapping repository body : ProtocolSimulationBatchRequest Protocol-based batch request with model (cycler config or regular), protocol_experiment, and optional design_parameters_doe activity_log_service : ActivityLogService Activity logging service

Returns

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

Raises

HTTPException If validation fails, usage limit reached, or job submission fails

Create Protocol Simulation Batch

cURL

curl --request POST \
  --url https://api.ionworks.com/simulations/protocol/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "parameterized_model": {},
  "protocol_experiment": {
    "protocol": "<string>",
    "name": "<string>",
    "additional_content_files": {},
    "parameters_schema": {}
  },
  "experiment_parameters": {},
  "design_parameters_doe": {
    "sampling": "grid",
    "rows": [
      {
        "name": "<string>",
        "type": "discrete",
        "values": [
          123
        ]
      }
    ],
    "count": 123
  },
  "max_backward_jumps": 123,
  "study_id": "<string>",
  "extra_variables": [
    "<string>"
  ],
  "force_rerun": false
}
'

202

[
  {
    "simulation_id": "<string>",
    "job_id": "<string>"
  }
]

Body

application/json

Request body for protocol-based batch simulation creation.

Strict interface for protocol-based batch simulations only. The parameterized_model field can be:

• A dict with "quick_model" key containing simplified model config (e.g., {"quick_model": {"capacity": 1.0, "chemistry": "NMC/Graphite"}})
• A regular parameterized model dict (with model, parameters)
• A parameterized model ID string

parameterized_model · Parameterized Model · object string · required

protocol_experiment · ProtocolExperimentConfig · object · required

Experiment configuration using protocol string or Protocol object.

Show child attributes

experiment_parameters · Experiment Parameters · object

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.

Show child attributes

max_backward_jumps · integer | null

study_id · string | null

extra_variables · string[] | null

force_rerun · boolean · default: false

Response

202

application/json

Successful Response

simulation_id · string · required

job_id · string · required