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 for creating multiple simulations with single model/template.
parameterized_model
Parameterized Model · objectstring
required
experiment_template_id
string
required
conditions
BatchCondition · object[] | null
Show child attributes
experiment_parameter_sets
Experiment Parameter Sets · object[] | null
experiment_conditions
Experiment Conditions · object[] | null
Show child attributes
design_parameters_doe
DOERequest · object | null
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
study_id
string | null
project_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
treat_pause_as_rest
boolean | null
simulation_settings
Simulation Settings · object | null
force_rerun
boolean
default:false
Response
Successful Response
simulation_id
string
required
job_id
string
required
already_existed
boolean
default:false
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.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ionworks Studio","colors":{"primary":"#FF87B7","light":"#FF87B7","dark":"#374151"},"logo":{"light":"https://mintcdn.com/ionworkstechnologiesinc/78EDZUH_SxrAKpqF/logo/ionworks-logo.svg?fit=max\u0026auto=format\u0026n=78EDZUH_SxrAKpqF\u0026q=85\u0026s=0bcd01f69aecbd26dc769194049dd31d","dark":"https://mintcdn.com/ionworkstechnologiesinc/78EDZUH_SxrAKpqF/logo/ionworks-logo.svg?fit=max\u0026auto=format\u0026n=78EDZUH_SxrAKpqF\u0026q=85\u0026s=0bcd01f69aecbd26dc769194049dd31d"},"favicon":"https://mintcdn.com/ionworkstechnologiesinc/78EDZUH_SxrAKpqF/logo/favicon.svg?fit=max\u0026auto=format\u0026n=78EDZUH_SxrAKpqF\u0026q=85\u0026s=55aa94615d149907650ce4517af33da6","api":{"playground":{"display":"none"}},"background":{"color":{"light":"#FAFAFA","dark":"#111827"}},"navbar":{"links":[{"href":"mailto:support@ionworks.com","label":"Support"}],"primary":{"type":"button","label":"Go to Studio","href":"https://studio.ionworks.com"}},"footer":{"socials":{"github":"https://github.com/ionworks","linkedin":"https://www.linkedin.com/company/ionworks-technologies"}},"seo":{"metatags":{"og:site_name":"Ionworks Studio","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@ionworks"},"indexing":"all"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://ionworks.com/blog"},{"anchor":"Changelog","icon":"star","href":"/changelog"},{"anchor":"Python package","icon":"python","href":"https://packages.docs.ionworks.com/ionworks/"},{"anchor":"PyBaMM","icon":"python","href":"https://docs.pybamm.org/en/latest/index.html"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ionworkstechnologiesinc","hasAudioNarration":false,"actualSubdomain":"ionworkstechnologiesinc","customDomains":["docs.ionworks.com"],"gitSource":{"type":"github","owner":"ionworks","repo":"ionworks-app","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5ed88c7a2465f288745d4","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":262},{"language":"default","tag":"Documentation","count":68},{"language":"default","tag":"Guide","count":34},{"language":"default","tag":"parameterized_models","count":30},{"language":"default","tag":"Cell Measurements","count":23},{"language":"default","tag":"Build","count":22},{"language":"default","tag":"Parameterize","count":16},{"language":"default","tag":"Batteries 101","count":15},{"language":"default","tag":"Model builders","count":15},{"language":"default","tag":"Physics-based","count":14}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@ionworks.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar-transition{pointer-events:none}#navbar-transition>*{pointer-events:auto}#content-area{padding-top:5rem}footer a[href*=\"mintlify.com\"]{display:none}"}],"page":{"pagePath":"api-reference/simulations/create-simulation-batch-with-template","slug":"/api-reference/simulations/create-simulation-batch-with-template","pageMetadata":{"title":"Create Simulation Batch With Template","description":"Optimized batch simulation creation with template-based experiments.\n\nThis endpoint is for creating multiple simulations using template-based\nexperiments with DOE support. For protocol-based batch simulations, use\nPOST /simulations/batch.\n\nReturns\n-------\nList[SimulationCreationResponse]\n List of simulation creation responses with IDs, job info, and status\n\nRaises\n------\nHTTPException\n If usage limit reached or job submission fails","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /simulations/with-template/batch","href":"/api-reference/simulations/create-simulation-batch-with-template","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n h2: \"h2\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Optimized batch simulation creation with template-based experiments.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint is for creating multiple simulations using template-based\\nexperiments with DOE support. For protocol-based batch simulations, use\\nPOST /simulations/batch.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Returns\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"List[SimulationCreationResponse]\\nList of simulation creation responses with IDs, job info, and status\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Raises\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"HTTPException\\nIf usage limit reached or job submission fails\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Simulation Batch With Template","description":"Optimized batch simulation creation with template-based experiments.\n\nThis endpoint is for creating multiple simulations using template-based\nexperiments with DOE support. For protocol-based batch simulations, use\nPOST /simulations/batch.\n\nReturns\n-------\nList[SimulationCreationResponse]\n List of simulation creation responses with IDs, job info, and status\n\nRaises\n------\nHTTPException\n If usage limit reached or job submission fails","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /simulations/with-template/batch","href":"/api-reference/simulations/create-simulation-batch-with-template","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Simulations"],"summary":"Create Simulation Batch With Template","description":"Optimized batch simulation creation with template-based experiments.\n\nThis endpoint is for creating multiple simulations using template-based\nexperiments with DOE support. For protocol-based batch simulations, use\nPOST /simulations/batch.\n\nReturns\n-------\nList[SimulationCreationResponse]\n List of simulation creation responses with IDs, job info, and status\n\nRaises\n------\nHTTPException\n If usage limit reached or job submission fails","operationId":"create_simulation_batch_with_template_simulations_with_template_batch_post","requestBody":"f5c024ab-f9f1-4851-8195-805a41c8e7e5","responses":{"202":"ffcac4eb-e03f-4223-a1cc-c8d91338edd7","422":"1d04316b-df75-46d5-b43e-c237ecaf3986"},"x-hidden":false,"method":"post","type":"path","servers":["8d449752-1c34-4367-90fb-c4d2998a1eb1"],"security":[],"path":"/simulations/with-template/batch","baseUrlOptions":["https://api.ionworks.com"],"title":"Create Simulation Batch With Template","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"parameterized_model":{"oneOf":[{"type":"object","title":"Parameterized Model","additionalProperties":true,"isRequired":true,"uniqueKey":"parameterized_model.oneOf.0","typeLabel":"Parameterized Model · object"},{"type":"string","title":"Parameterized Model","isRequired":true,"uniqueKey":"parameterized_model.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"parameterized_model","typeLabel":"Parameterized Model · object | string"},"experiment_template_id":{"type":"string","title":"Experiment Template Id","isRequired":true,"uniqueKey":"experiment_template_id","typeLabel":"string"},"conditions":{"oneOf":[{"type":"array","items":{"properties":{"experiment_parameters":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"conditions.oneOf.0.items.[INDEX].experiment_parameters.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"conditions.oneOf.0.items.[INDEX].experiment_parameters.additionalProperties.oneOf.1","typeLabel":"number"}],"uniqueKey":"conditions.oneOf.0.items.[INDEX].experiment_parameters.additionalProperties","typeLabel":"string | number"},"type":"object","title":"Experiment Parameters","uniqueKey":"conditions.oneOf.0.items.[INDEX].experiment_parameters","typeLabel":"Experiment Parameters · object"},"design_parameters":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"object","title":"DesignParameterTable","description":"A function-valued design parameter: a lookup table, interpolated in ``x``.\n\nReplaces a parameter function with an interpolant in its first input, the\nothers ignored: conductivity against concentration replaces a function of\nconcentration and temperature.","required":["x","y"],"properties":{"x":{"items":{"type":"number","uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.2.x.items.[INDEX]","typeLabel":"number"},"type":"array","title":"X","description":"Input values, strictly increasing.","isRequired":true,"uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.2.x","typeLabel":"number[]"},"y":{"items":{"type":"number","uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.2.y.items.[INDEX]","typeLabel":"number"},"type":"array","title":"Y","description":"Parameter value at each x.","isRequired":true,"uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.2.y","typeLabel":"number[]"},"interpolator":{"type":"string","enum":["linear","cubic","pchip"],"title":"Interpolator","default":"linear","uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.2.interpolator","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties.oneOf.2","typeLabel":"DesignParameterTable · object"}],"uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters.additionalProperties","typeLabel":"string | number | DesignParameterTable · object"},"type":"object","title":"Design Parameters","uniqueKey":"conditions.oneOf.0.items.[INDEX].design_parameters","typeLabel":"Design Parameters · object"}},"type":"object","title":"BatchCondition","description":"A single paired condition for batch simulation creation.\n\nUsed when each simulation needs its own specific experiment and design\nparameter combination, as opposed to the DOE cross-product approach.","uniqueKey":"conditions.oneOf.0.items.[INDEX]","typeLabel":"BatchCondition · object"},"title":"Conditions","uniqueKey":"conditions.oneOf.0","typeLabel":"BatchCondition · object[]"},{"type":"null","title":"Conditions","uniqueKey":"conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"conditions","typeLabel":"BatchCondition · object[] | null"},"experiment_parameter_sets":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"experiment_parameter_sets.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Experiment Parameter Sets","uniqueKey":"experiment_parameter_sets.oneOf.0","typeLabel":"Experiment Parameter Sets · object[]"},{"type":"null","title":"Experiment Parameter Sets","uniqueKey":"experiment_parameter_sets.oneOf.1","typeLabel":"null"}],"uniqueKey":"experiment_parameter_sets","typeLabel":"Experiment Parameter Sets · object[] | null"},"experiment_conditions":{"oneOf":[{"type":"array","items":{"additionalProperties":{"type":"string","uniqueKey":"experiment_conditions.oneOf.0.items.[INDEX].additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"experiment_conditions.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Experiment Conditions","uniqueKey":"experiment_conditions.oneOf.0","typeLabel":"Experiment Conditions · object[]"},{"type":"null","title":"Experiment Conditions","uniqueKey":"experiment_conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"experiment_conditions","typeLabel":"Experiment Conditions · object[] | null"},"design_parameters_doe":{"oneOf":[{"type":"object","title":"DOERequest","description":"Design of Experiments request with rows.\n\nParameters\n----------\nsampling\n Sampling strategy. Supported: ``grid`` (cartesian product).\nrows\n List of parameter rows; each carries its own type and config fields.\ncount\n Number of samples for non-grid methods (required). Ignored for\n ``grid`` sampling.","properties":{"sampling":{"type":"string","title":"Sampling","default":"grid","uniqueKey":"design_parameters_doe.oneOf.0.sampling","typeLabel":"string"},"rows":{"items":{"oneOf":[{"type":"object","title":"DiscreteParam","description":"Discrete parameter configuration.\n\nParameters\n----------\nname\n Parameter name.\nvalues\n List of allowed numeric values.","required":["name"],"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.0.name","typeLabel":"string"},"type":{"type":"string","const":"discrete","title":"Type","default":"discrete","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.0.type","typeLabel":"string"},"values":{"items":{"type":"number","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.0.values.items.[INDEX]","typeLabel":"number"},"type":"array","title":"Values","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.0.values","typeLabel":"number[]"}},"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.0","typeLabel":"DiscreteParam · object"},{"type":"object","title":"RangeParam","description":"Range parameter configuration.\n\nParameters\n----------\nname\n Parameter name.\nmin\n Minimum value (inclusive).\nmax\n Maximum value (inclusive).\ncount\n Optional grid sample count for this parameter. Required for\n ``grid`` sampling; ignored for non-grid methods.","required":["name","min","max"],"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.name","typeLabel":"string"},"min":{"type":"number","title":"Min","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.min","typeLabel":"number"},"max":{"type":"number","title":"Max","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.max","typeLabel":"number"},"type":{"type":"string","const":"range","title":"Type","default":"range","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.type","typeLabel":"string"},"count":{"oneOf":[{"type":"integer","title":"Count","minimum":1,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Count","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.count.oneOf.1","typeLabel":"null"}],"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1.count","typeLabel":"integer | null"}},"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.1","typeLabel":"RangeParam · object"},{"type":"object","title":"NormalParam","description":"Normal parameter configuration.\n\nParameters\n----------\nname\n Parameter name.\nmean\n Mean of the distribution.\nstd\n Standard deviation of the distribution.\ncount\n Optional grid sample count for this parameter. Required for\n ``grid`` sampling; ignored for non-grid methods.","required":["name","mean","std"],"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.name","typeLabel":"string"},"mean":{"type":"number","title":"Mean","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.mean","typeLabel":"number"},"std":{"type":"number","title":"Std","isRequired":true,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.std","typeLabel":"number"},"type":{"type":"string","const":"normal","title":"Type","default":"normal","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.type","typeLabel":"string"},"count":{"oneOf":[{"type":"integer","title":"Count","minimum":1,"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Count","uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.count.oneOf.1","typeLabel":"null"}],"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2.count","typeLabel":"integer | null"}},"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX].oneOf.2","typeLabel":"NormalParam · object"}],"uniqueKey":"design_parameters_doe.oneOf.0.rows.items.[INDEX]","typeLabel":"DiscreteParam · object | RangeParam · object | NormalParam · object"},"type":"array","title":"Rows","uniqueKey":"design_parameters_doe.oneOf.0.rows","typeLabel":"(DiscreteParam · object | RangeParam · object | NormalParam · object)[]"},"count":{"oneOf":[{"type":"integer","title":"Count","uniqueKey":"design_parameters_doe.oneOf.0.count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Count","uniqueKey":"design_parameters_doe.oneOf.0.count.oneOf.1","typeLabel":"null"}],"uniqueKey":"design_parameters_doe.oneOf.0.count","typeLabel":"integer | null"}},"uniqueKey":"design_parameters_doe.oneOf.0","typeLabel":"DOERequest · object"},{"type":"null","uniqueKey":"design_parameters_doe.oneOf.1","typeLabel":"null"}],"uniqueKey":"design_parameters_doe","typeLabel":"DOERequest · object | null"},"study_id":{"oneOf":[{"type":"string","title":"Study Id","uniqueKey":"study_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Study Id","uniqueKey":"study_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"study_id","typeLabel":"string | null"},"project_id":{"oneOf":[{"type":"string","title":"Project Id","uniqueKey":"project_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Project Id","uniqueKey":"project_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"project_id","typeLabel":"string | null"},"max_backward_jumps":{"oneOf":[{"type":"integer","title":"Max Backward Jumps","uniqueKey":"max_backward_jumps.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Backward Jumps","uniqueKey":"max_backward_jumps.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_backward_jumps","typeLabel":"integer | null"},"extra_variables":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"extra_variables.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Extra Variables","uniqueKey":"extra_variables.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Extra Variables","uniqueKey":"extra_variables.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra_variables","typeLabel":"string[] | null"},"variable_callback_rules":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"variable_callback_rules.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Variable Callback Rules","uniqueKey":"variable_callback_rules.oneOf.0","typeLabel":"Variable Callback Rules · object[]"},{"type":"null","title":"Variable Callback Rules","uniqueKey":"variable_callback_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"variable_callback_rules","typeLabel":"Variable Callback Rules · object[] | null"},"termination_condition_rules":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"termination_condition_rules.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Termination Condition Rules","uniqueKey":"termination_condition_rules.oneOf.0","typeLabel":"Termination Condition Rules · object[]"},{"type":"null","title":"Termination Condition Rules","uniqueKey":"termination_condition_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"termination_condition_rules","typeLabel":"Termination Condition Rules · object[] | null"},"treat_pause_as_rest":{"oneOf":[{"type":"boolean","title":"Treat Pause As Rest","uniqueKey":"treat_pause_as_rest.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Treat Pause As Rest","uniqueKey":"treat_pause_as_rest.oneOf.1","typeLabel":"null"}],"uniqueKey":"treat_pause_as_rest","typeLabel":"boolean | null"},"simulation_settings":{"oneOf":[{"type":"object","title":"Simulation Settings","additionalProperties":true,"uniqueKey":"simulation_settings.oneOf.0","typeLabel":"Simulation Settings · object"},{"type":"null","title":"Simulation Settings","uniqueKey":"simulation_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"simulation_settings","typeLabel":"Simulation Settings · object | null"},"force_rerun":{"type":"boolean","title":"Force Rerun","default":false,"uniqueKey":"force_rerun","typeLabel":"boolean"}},"type":"object","required":["parameterized_model","experiment_template_id"],"title":"CreateSimulationBatchBody","description":"Request body for creating multiple simulations with single model/template.","uniqueKey":"","typeLabel":"CreateSimulationBatchBody · object"},"examples":{"Example":{"title":"Example","value":{"parameterized_model":{},"experiment_template_id":"\u003cstring>","conditions":[{"experiment_parameters":{},"design_parameters":{}}],"experiment_parameter_sets":[{}],"experiment_conditions":[{}],"design_parameters_doe":{"sampling":"grid","rows":[{"name":"\u003cstring>","type":"discrete","values":[123]}],"count":123},"study_id":"\u003cstring>","project_id":"\u003cstring>","max_backward_jumps":123,"extra_variables":["\u003cstring>"],"variable_callback_rules":[{}],"termination_condition_rules":[{}],"treat_pause_as_rest":true,"simulation_settings":{},"force_rerun":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"ffcac4eb-e03f-4223-a1cc-c8d91338edd7":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"properties":{"simulation_id":{"type":"string","title":"Simulation Id","isRequired":true,"uniqueKey":"items.[INDEX].simulation_id","typeLabel":"string"},"job_id":{"type":"string","title":"Job Id","isRequired":true,"uniqueKey":"items.[INDEX].job_id","typeLabel":"string"},"already_existed":{"type":"boolean","title":"Already Existed","description":"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.","default":false,"uniqueKey":"items.[INDEX].already_existed","typeLabel":"boolean"}},"type":"object","required":["simulation_id","job_id"],"title":"SimulationCreationResponse","description":"Response for simulation creation requests.","uniqueKey":"items.[INDEX]","typeLabel":"SimulationCreationResponse · object"},"type":"array","title":"Response Create Simulation Batch With Template Simulations With Template Batch Post","uniqueKey":"","typeLabel":"SimulationCreationResponse · object[]"},"examples":{"Example":{"title":"Example","value":[{"simulation_id":"\u003cstring>","job_id":"\u003cstring>","already_existed":false}]}},"exampleType":"generated"}},"exampleType":"generated"},"1d04316b-df75-46d5-b43e-c237ecaf3986":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"8d449752-1c34-4367-90fb-c4d2998a1eb1":{"url":"https://api.ionworks.com","description":"Production"}}},"originalFileLocation":"https://api.ionworks.com/openapi.json"},"subdomain":"ionworkstechnologiesinc","siteName":"Ionworks Studio","title":"Create Simulation Batch With Template - Ionworks Studio","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T10:46:25.705Z","originalFileLocation":"api-reference/simulations/create-simulation-batch-with-template.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ionworks Studio\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Simulation Batch With Template - Ionworks Studio\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ionworks Studio\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ionworkstechnologiesinc.mintlify.site/_mintlify/api/og/v2?division=Simulations\u0026amp;title=Create+Simulation+Batch+With+Template\u0026amp;description=Optimized+batch+simulation+creation+with+template-based+experiments.%0A%0AThis+endpoint+is+for+creating+multiple+simulations+using+template-based%0Aexperiments+with+D\u0026amp;theme=190291fcc040aef33b6870ca\u0026amp;signature=9ae5a2479c29323931e46a979e91d942d8773dd28761403823b684f0a5ddc6a5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Simulation Batch With Template - Ionworks Studio\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ionworkstechnologiesinc.mintlify.site/_mintlify/api/og/v2?division=Simulations\u0026amp;title=Create+Simulation+Batch+With+Template\u0026amp;description=Optimized+batch+simulation+creation+with+template-based+experiments.%0A%0AThis+endpoint+is+for+creating+multiple+simulations+using+template-based%0Aexperiments+with+D\u0026amp;theme=190291fcc040aef33b6870ca\u0026amp;signature=9ae5a2479c29323931e46a979e91d942d8773dd28761403823b684f0a5ddc6a5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ionworkstechnologiesinc/EPOKZ36crJVbp4XG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ionworks Studio\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF87B7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/simulations/create-simulation-batch-with-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ionworks.com/#organization\",\"name\":\"Ionworks Studio\",\"url\":\"https://docs.ionworks.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ionworkstechnologiesinc/78EDZUH_SxrAKpqF/logo/ionworks-logo.svg?fit=max\u0026auto=format\u0026n=78EDZUH_SxrAKpqF\u0026q=85\u0026s=0bcd01f69aecbd26dc769194049dd31d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ionworks.com#website\",\"name\":\"Ionworks Studio\",\"url\":\"https://docs.ionworks.com\",\"publisher\":{\"@id\":\"https://docs.ionworks.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template#webpage\",\"url\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template\",\"name\":\"Create Simulation Batch With Template\",\"description\":\"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\",\"dateModified\":\"2026-11-10T10:46:25.705Z\",\"isPartOf\":{\"@id\":\"https://docs.ionworks.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Simulations\",\"item\":\"https://docs.ionworks.com/api-reference/simulations/list-simulations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Simulation Batch With Template\",\"item\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template#apireference\",\"headline\":\"Create Simulation Batch With Template\",\"name\":\"Create Simulation Batch With Template\",\"description\":\"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\",\"url\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template#webpage\"},\"dateModified\":\"2026-11-10T10:46:25.705Z\",\"publisher\":{\"@id\":\"https://docs.ionworks.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ionworks.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ionworks Studio\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ionworks Studio\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/simulations/create-simulation-batch-with-template.md","siteName":"Ionworks Studio","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://ionworks.com/blog"},{"anchor":"Changelog","icon":"star","href":"/changelog"},{"anchor":"Python package","icon":"python","href":"https://packages.docs.ionworks.com/ionworks/"},{"anchor":"PyBaMM","icon":"python","href":"https://docs.pybamm.org/en/latest/index.html"}]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Guide","icon":"graduation-cap","pages":[{"title":"Guide","href":"/guide/introduction"}]},{"tab":"API Reference","groups":[{"group":"Cell Specifications","pages":[{"title":"List cell instances for a cell specification","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications/{cell_spec_id}/cell_instances","href":"/api-reference/cell-specifications/list-cell-instances-for-a-cell-specification"},{"title":"Create a new cell instance for a cell specification","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_specifications/{cell_spec_id}/cell_instances","href":"/api-reference/cell-specifications/create-a-new-cell-instance-for-a-cell-specification"},{"title":"List the batches of a cell specification","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications/{cell_spec_id}/cell_batches","href":"/api-reference/cell-specifications/list-the-batches-of-a-cell-specification"},{"title":"Create a batch (manufacturing lot) for a cell specification","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_specifications/{cell_spec_id}/cell_batches","href":"/api-reference/cell-specifications/create-a-batch-manufacturing-lot-for-a-cell-specification"},{"title":"List cell specifications for the current organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications","href":"/api-reference/cell-specifications/list-cell-specifications-for-the-current-organization"},{"title":"Create a new cell specification with nested component/material data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_specifications","href":"/api-reference/cell-specifications/create-a-new-cell-specification-with-nested-componentmaterial-data"},{"title":"Get a cell specification with nested component and material data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications/{cell_spec_id}","href":"/api-reference/cell-specifications/get-a-cell-specification-with-nested-component-and-material-data"},{"title":"Delete a cell specification by id for the current organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cell_specifications/{cell_spec_id}","href":"/api-reference/cell-specifications/delete-a-cell-specification-by-id-for-the-current-organization"},{"title":"Update a cell specification with nested component/material data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_specifications/{cell_spec_id}","href":"/api-reference/cell-specifications/update-a-cell-specification-with-nested-componentmaterial-data"},{"title":"Initiate a signed-URL CAD model upload","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_specifications/{cell_spec_id}/cad/initiate-upload","href":"/api-reference/cell-specifications/initiate-a-signed-url-cad-model-upload"},{"title":"Attach an uploaded CAD model and render its thumbnail","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_specifications/{cell_spec_id}/cad/confirm-upload","href":"/api-reference/cell-specifications/attach-an-uploaded-cad-model-and-render-its-thumbnail"},{"title":"Get signed URLs for a cell specification's CAD model and thumbnail","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications/{cell_spec_id}/cad","href":"/api-reference/cell-specifications/get-signed-urls-for-a-cell-specifications-cad-model-and-thumbnail"},{"title":"Remove a cell specification's CAD model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cell_specifications/{cell_spec_id}/cad","href":"/api-reference/cell-specifications/remove-a-cell-specifications-cad-model"}]},{"group":"Cell Instances","pages":[{"title":"List cell measurements for a cell instance","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_instances/{cell_instance_id}/cell_measurements","href":"/api-reference/cell-instances/list-cell-measurements-for-a-cell-instance"},{"title":"Create a properties-type measurement directly","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_instances/{cell_instance_id}/cell_measurements/create","href":"/api-reference/cell-instances/create-a-properties-type-measurement-directly"},{"title":"Initiate a signed URL upload for measurement data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_instances/{cell_instance_id}/cell_measurements/initiate-upload","href":"/api-reference/cell-instances/initiate-a-signed-url-upload-for-measurement-data"},{"title":"Get a specific cell instance by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_instances/{cell_instance_id}","href":"/api-reference/cell-instances/get-a-specific-cell-instance-by-id"},{"title":"Delete a specific cell instance by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cell_instances/{cell_instance_id}","href":"/api-reference/cell-instances/delete-a-specific-cell-instance-by-id"},{"title":"Update a specific cell instance by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_instances/{cell_instance_id}","href":"/api-reference/cell-instances/update-a-specific-cell-instance-by-id"},{"title":"Report a cell instance as failed, or clear the report","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_instances/{cell_instance_id}/failure","href":"/api-reference/cell-instances/report-a-cell-instance-as-failed-or-clear-the-report"}]},{"group":"Cell Batches","pages":[{"title":"Get a cell batch by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_batches/{batch_id}","href":"/api-reference/cell-batches/get-a-cell-batch-by-id"},{"title":"Delete a cell batch","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cell_batches/{batch_id}","href":"/api-reference/cell-batches/delete-a-cell-batch"},{"title":"Update a cell batch","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_batches/{batch_id}","href":"/api-reference/cell-batches/update-a-cell-batch"}]},{"group":"Cell Measurements","pages":[{"title":"List cell measurements","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements","href":"/api-reference/cell-measurements/list-cell-measurements"},{"title":"List the JSON metadata fields measurements in a scope carry","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/metadata_fields","href":"/api-reference/cell-measurements/list-the-json-metadata-fields-measurements-in-a-scope-carry"},{"title":"List a project's measurement tags with usage counts","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/tags","href":"/api-reference/cell-measurements/list-a-projects-measurement-tags-with-usage-counts"},{"title":"Add or remove tags on many measurements","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_measurements/tags/bulk","href":"/api-reference/cell-measurements/add-or-remove-tags-on-many-measurements"},{"title":"Export measurement data (time series, steps, files, metadata) as a zip","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_measurements/export","href":"/api-reference/cell-measurements/export-measurement-data-time-series-steps-files-metadata-as-a-zip"},{"title":"Get a cell measurement by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}","href":"/api-reference/cell-measurements/get-a-cell-measurement-by-id"},{"title":"Delete a specific cell measurement by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cell_measurements/{measurement_id}","href":"/api-reference/cell-measurements/delete-a-specific-cell-measurement-by-id"},{"title":"Update a cell measurement by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_measurements/{measurement_id}","href":"/api-reference/cell-measurements/update-a-cell-measurement-by-id"},{"title":"Get detailed information for a cell measurement","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/detail","href":"/api-reference/cell-measurements/get-detailed-information-for-a-cell-measurement"},{"title":"Estimate a running measurement's end time from its remaining protocol","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_measurements/{measurement_id}/estimate_end_time","href":"/api-reference/cell-measurements/estimate-a-running-measurements-end-time-from-its-remaining-protocol"},{"title":"Report a cell measurement as failed, or clear the report","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cell_measurements/{measurement_id}/failure","href":"/api-reference/cell-measurements/report-a-cell-measurement-as-failed-or-clear-the-report"},{"title":"Get all steps for a cell measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/steps","href":"/api-reference/cell-measurements/get-all-steps-for-a-cell-measurement"},{"title":"Get steps and cycle metrics in one call","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/steps_and_cycles","href":"/api-reference/cell-measurements/get-steps-and-cycle-metrics-in-one-call"},{"title":"Get cycle metrics only for a cell measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/cycles","href":"/api-reference/cell-measurements/get-cycle-metrics-only-for-a-cell-measurement"},{"title":"Download time series parquet file","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/time_series/download","href":"/api-reference/cell-measurements/download-time-series-parquet-file"},{"title":"Download steps parquet file","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/steps/download","href":"/api-reference/cell-measurements/download-steps-parquet-file"},{"title":"List files in a measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/files","href":"/api-reference/cell-measurements/list-files-in-a-measurement"},{"title":"Download a measurement file","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_measurements/{measurement_id}/files/{filename}","href":"/api-reference/cell-measurements/download-a-measurement-file"},{"title":"Confirm a signed URL upload and finalize the measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_measurements/{measurement_id}/confirm-upload","href":"/api-reference/cell-measurements/confirm-a-signed-url-upload-and-finalize-the-measurement"},{"title":"Initiate signed URL upload to extend a measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_measurements/{measurement_id}/initiate-extend","href":"/api-reference/cell-measurements/initiate-signed-url-upload-to-extend-a-measurement"},{"title":"Confirm extend upload; stitch series and recompute steps","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_measurements/{measurement_id}/confirm-extend","href":"/api-reference/cell-measurements/confirm-extend-upload;-stitch-series-and-recompute-steps"},{"title":"Watch a measurement (Lab 'My Channels')","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cell_measurements/{measurement_id}/watch","href":"/api-reference/cell-measurements/watch-a-measurement-lab-my-channels"},{"title":"Stop watching a measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cell_measurements/{measurement_id}/watch","href":"/api-reference/cell-measurements/stop-watching-a-measurement"}]},{"group":"Uncountable","pages":[{"title":"Create cell specifications and instances from Uncountable recipes","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /integrations/uncountable/sync","href":"/api-reference/uncountable/create-cell-specifications-and-instances-from-uncountable-recipes"},{"title":"Whether results, such as cell failures, are written to Uncountable","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /integrations/uncountable/writeback","href":"/api-reference/uncountable/whether-results-such-as-cell-failures-are-written-to-uncountable"}]},{"group":"Programs","pages":[{"title":"List programs","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /programs","href":"/api-reference/programs/list-programs"},{"title":"Create a new program","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /programs","href":"/api-reference/programs/create-a-new-program"},{"title":"Get a specific program by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /programs/{program_id}","href":"/api-reference/programs/get-a-specific-program-by-id"},{"title":"Delete a specific program by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /programs/{program_id}","href":"/api-reference/programs/delete-a-specific-program-by-id"},{"title":"Update a specific program by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /programs/{program_id}","href":"/api-reference/programs/update-a-specific-program-by-id"}]},{"group":"Sites","pages":[{"title":"List cyclers for a site","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /sites/{site_id}/cyclers","href":"/api-reference/sites/list-cyclers-for-a-site"},{"title":"Create a new cycler for a site","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /sites/{site_id}/cyclers","href":"/api-reference/sites/create-a-new-cycler-for-a-site"},{"title":"List thermal chambers for a site","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /sites/{site_id}/thermal_chambers","href":"/api-reference/sites/list-thermal-chambers-for-a-site"},{"title":"Create a new thermal chamber for a site","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /sites/{site_id}/thermal_chambers","href":"/api-reference/sites/create-a-new-thermal-chamber-for-a-site"},{"title":"List sites","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /sites","href":"/api-reference/sites/list-sites"},{"title":"Create a new site","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /sites","href":"/api-reference/sites/create-a-new-site"},{"title":"Get a specific site by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /sites/{site_id}","href":"/api-reference/sites/get-a-specific-site-by-id"},{"title":"Delete a specific site by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /sites/{site_id}","href":"/api-reference/sites/delete-a-specific-site-by-id"},{"title":"Update a specific site by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /sites/{site_id}","href":"/api-reference/sites/update-a-specific-site-by-id"}]},{"group":"Cyclers","pages":[{"title":"List channels for a cycler","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cyclers/{cycler_id}/channels","href":"/api-reference/cyclers/list-channels-for-a-cycler"},{"title":"Create a new channel for a cycler","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cyclers/{cycler_id}/channels","href":"/api-reference/cyclers/create-a-new-channel-for-a-cycler"},{"title":"List cyclers","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cyclers","href":"/api-reference/cyclers/list-cyclers"},{"title":"Get a specific cycler by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cyclers/{cycler_id}","href":"/api-reference/cyclers/get-a-specific-cycler-by-id"},{"title":"Delete a specific cycler by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cyclers/{cycler_id}","href":"/api-reference/cyclers/delete-a-specific-cycler-by-id"},{"title":"Update a specific cycler by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cyclers/{cycler_id}","href":"/api-reference/cyclers/update-a-specific-cycler-by-id"},{"title":"List a cycler's service history","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cyclers/{cycler_id}/service_events","href":"/api-reference/cyclers/list-a-cyclers-service-history"},{"title":"Take a cycler out of service for planned work","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cyclers/{cycler_id}/service_events","href":"/api-reference/cyclers/take-a-cycler-out-of-service-for-planned-work"},{"title":"Get a cycler's open service event, if any","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cyclers/{cycler_id}/service_events/open","href":"/api-reference/cyclers/get-a-cyclers-open-service-event-if-any"},{"title":"Record a cycler's open service as done","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cyclers/{cycler_id}/service_events/complete","href":"/api-reference/cyclers/record-a-cyclers-open-service-as-done"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /channels","href":"/api-reference/channels/list-channels"},{"title":"Get a specific channel by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-a-specific-channel-by-id"},{"title":"Delete a specific channel by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-a-specific-channel-by-id"},{"title":"Update a specific channel by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-a-specific-channel-by-id"},{"title":"List a channel's out-of-service history","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /channels/{channel_id}/incidents","href":"/api-reference/channels/list-a-channels-out-of-service-history"}]},{"group":"Thermal chambers","pages":[{"title":"List thermal chambers","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /thermal_chambers","href":"/api-reference/thermal-chambers/list-thermal-chambers"},{"title":"Get a specific thermal chamber by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /thermal_chambers/{thermal_chamber_id}","href":"/api-reference/thermal-chambers/get-a-specific-thermal-chamber-by-id"},{"title":"Delete a specific thermal chamber by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /thermal_chambers/{thermal_chamber_id}","href":"/api-reference/thermal-chambers/delete-a-specific-thermal-chamber-by-id"},{"title":"Update a specific thermal chamber by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /thermal_chambers/{thermal_chamber_id}","href":"/api-reference/thermal-chambers/update-a-specific-thermal-chamber-by-id"}]},{"group":"Simulations","pages":[{"title":"List Simulations","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations","href":"/api-reference/simulations/list-simulations"},{"title":"Get Simulation Summary","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/summary","href":"/api-reference/simulations/get-simulation-summary"},{"title":"Get Simulation","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}","href":"/api-reference/simulations/get-simulation"},{"title":"Get Simulation Result","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/result","href":"/api-reference/simulations/get-simulation-result"},{"title":"Download simulation time series parquet","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/time_series/download","href":"/api-reference/simulations/download-simulation-time-series-parquet"},{"title":"Download simulation steps parquet","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/steps/download","href":"/api-reference/simulations/download-simulation-steps-parquet"},{"title":"Get Simulation Spatial Profile","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/spatial-profile","href":"/api-reference/simulations/get-simulation-spatial-profile"},{"title":"Get Simulation Spatial Field","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/spatial-field","href":"/api-reference/simulations/get-simulation-spatial-field"},{"title":"Get Simulation Cycles","description":"Get cycle-level metrics for a simulation.\n\nComputes metrics like discharge capacity, coulombic efficiency, capacity\nretention, etc. for each cycle from the steps.parquet file using\nionworksdata.cycle_metrics.get_cycle_metrics.\n\nParameters\n----------\nsimulation_id : str\n ID of the simulation\nuser_org_client : tuple[str, str | None, AsyncClient]\n Current user_id, organization_id, and Supabase client\nsimulation_repository : SimulationRepository\n Repository for simulations table\nsimulation_data_repository : SimulationDataRepository\n Repository for simulation_data table\n\nReturns\n-------\ndict\n Dictionary with cycle metrics as lists, one value per cycle.\n Keys include: Cycle number, Discharge capacity [A.h],\n Charge capacity [A.h], Coulombic efficiency, Capacity retention, etc.\n\nRaises\n------\nHTTPException\n 404 if no results found, 500 for computation errors","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simulations/{simulation_id}/cycles","href":"/api-reference/simulations/get-simulation-cycles"},{"title":"Create Simulation Batch With Template","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /simulations/with-template/batch","href":"/api-reference/simulations/create-simulation-batch-with-template"}]},{"group":"parameterized_models","pages":[{"title":"List parameterized models for a cell specification or project","description":"List parameterized models with pagination, filtering, and sorting, scoped\nby cell spec or project.\n\nProvide exactly one scope:\n\n- ``cell_spec_id`` lists models for a single cell specification. This is the\n path parameter when called via ``/cells/{cell_spec_id}/parameterized_models``.\n- ``project_id`` lists models across every cell specification linked to the\n project. ``cell_spec_id`` may additionally be passed to narrow a\n project-scoped query to one cell specification.\n\nParameters\n----------\nmodel_id : str | None\n Base model to narrow to, matched exactly. Composes with either scope —\n e.g. every parameterized model in a project that derives from one model.\ncell_spec_id : str | None\n Cell specification to scope to. Required when ``project_id`` is not given.\nproject_id : str | None\n Project to scope to. When set, ``cell_spec_id`` is an optional further\n filter rather than the primary scope.\nname : str | None\n Column filter on the model name. Applies to both scopes. Values use\n Supabase operator syntax and are validated by the field policy — e.g.\n ``ilike.%alpha%`` for a case-insensitive substring match. A bare value\n falls through to an exact match.\ndescription : str | None\n Column filter on the model description. Same operator-syntax semantics\n as ``name`` and likewise applies to both scopes.\nq : str | None\n Free-text search on the model name plus a prefix full-text match,\n matching the global search. Applies to both scopes and composes with\n the ``name`` / ``description`` column filters.\norder_by : {\"name\", \"created_at\"}\n Column to sort the cell-spec-scoped results by. Defaults to\n ``\"created_at\"``.\norder : {\"asc\", \"desc\"}\n Sort direction for the cell-spec-scoped results. Defaults to ``\"desc\"``.\nlimit : int\n Maximum number of models to return per page (1-1000). Defaults to 100.\n The upper bound is 1000 so callers (e.g. the optimization clone form)\n can load every model for a project in one request.\noffset : int\n Number of models to skip for pagination. Defaults to 0.\nsummary : bool\n Return summaries without the parameter values, which a full record\n inlines and which can run to hundreds of thousands of characters per\n model. Defaults to False.\ncurrent_only : bool\n Return only each family's current version. Defaults to False,\n so callers resolving a simulation's model by id still find older versions.","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models","href":"/api-reference/parameterized_models/list-parameterized-models-for-a-cell-specification-or-project"},{"title":"Create a parameterized model for a cell specification or project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cells/{cell_spec_id}/parameterized_models","href":"/api-reference/parameterized_models/create-a-parameterized-model-for-a-cell-specification-or-project"},{"title":"Get a parameterized model by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}","href":"/api-reference/parameterized_models/get-a-parameterized-model-by-id"},{"title":"Delete a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}","href":"/api-reference/parameterized_models/delete-a-parameterized-model"},{"title":"Update a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}","href":"/api-reference/parameterized_models/update-a-parameterized-model"},{"title":"List the versions of a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/versions","href":"/api-reference/parameterized_models/list-the-versions-of-a-parameterized-model"},{"title":"Create a new version of a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/versions","href":"/api-reference/parameterized_models/create-a-new-version-of-a-parameterized-model"},{"title":"Make a version of a parameterized model its family's current one","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/restore","href":"/api-reference/parameterized_models/make-a-version-of-a-parameterized-model-its-familys-current-one"},{"title":"Get Parameterized Model Parameter Values","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/parameter-values","href":"/api-reference/parameterized_models/get-parameterized-model-parameter-values"},{"title":"Get Parameterized Model Function Curves","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/function-curves","href":"/api-reference/parameterized_models/get-parameterized-model-function-curves"},{"title":"Get Parameterized Model Report","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/report","href":"/api-reference/parameterized_models/get-parameterized-model-report"},{"title":"Export Parameterized Model Code","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/export","href":"/api-reference/parameterized_models/export-parameterized-model-code"},{"title":"Get Parameterized Model Variable Names","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/variable-names","href":"/api-reference/parameterized_models/get-parameterized-model-variable-names"},{"title":"Get Parameterized Model Spatial Variable Names","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/spatial-variable-names","href":"/api-reference/parameterized_models/get-parameterized-model-spatial-variable-names"},{"title":"Get Parameterized Model Field Variable Names","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cells/{cell_spec_id}/parameterized_models/{parameterized_model_id}/field-variable-names","href":"/api-reference/parameterized_models/get-parameterized-model-field-variable-names"},{"title":"List parameterized models for a cell specification or project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models","href":"/api-reference/parameterized_models/list-parameterized-models-for-a-cell-specification-or-project-1"},{"title":"Create a parameterized model for a cell specification or project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /parameterized_models","href":"/api-reference/parameterized_models/create-a-parameterized-model-for-a-cell-specification-or-project-1"},{"title":"Get a parameterized model by id","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}","href":"/api-reference/parameterized_models/get-a-parameterized-model-by-id-1"},{"title":"Delete a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /parameterized_models/{parameterized_model_id}","href":"/api-reference/parameterized_models/delete-a-parameterized-model-1"},{"title":"Update a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /parameterized_models/{parameterized_model_id}","href":"/api-reference/parameterized_models/update-a-parameterized-model-1"},{"title":"List the versions of a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/versions","href":"/api-reference/parameterized_models/list-the-versions-of-a-parameterized-model-1"},{"title":"Create a new version of a parameterized model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /parameterized_models/{parameterized_model_id}/versions","href":"/api-reference/parameterized_models/create-a-new-version-of-a-parameterized-model-1"},{"title":"Make a version of a parameterized model its family's current one","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /parameterized_models/{parameterized_model_id}/restore","href":"/api-reference/parameterized_models/make-a-version-of-a-parameterized-model-its-familys-current-one-1"},{"title":"Get Parameterized Model Parameter Values","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/parameter-values","href":"/api-reference/parameterized_models/get-parameterized-model-parameter-values-1"},{"title":"Get Parameterized Model Function Curves","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/function-curves","href":"/api-reference/parameterized_models/get-parameterized-model-function-curves-1"},{"title":"Get Parameterized Model Report","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/report","href":"/api-reference/parameterized_models/get-parameterized-model-report-1"},{"title":"Export Parameterized Model Code","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/export","href":"/api-reference/parameterized_models/export-parameterized-model-code-1"},{"title":"Get Parameterized Model Variable Names","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/variable-names","href":"/api-reference/parameterized_models/get-parameterized-model-variable-names-1"},{"title":"Get Parameterized Model Spatial Variable Names","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/spatial-variable-names","href":"/api-reference/parameterized_models/get-parameterized-model-spatial-variable-names-1"},{"title":"Get Parameterized Model Field Variable Names","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /parameterized_models/{parameterized_model_id}/field-variable-names","href":"/api-reference/parameterized_models/get-parameterized-model-field-variable-names-1"}]},{"group":"discovery","pages":[{"title":"Get Capabilities","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/capabilities","href":"/api-reference/discovery/get-capabilities"},{"title":"Get Data Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/data","href":"/api-reference/discovery/get-data-schema"},{"title":"Get Protocol Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/protocol","href":"/api-reference/discovery/get-protocol-schema"},{"title":"Get Project Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/project","href":"/api-reference/discovery/get-project-schema"},{"title":"Get Lab Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/lab","href":"/api-reference/discovery/get-lab-schema"},{"title":"Get Study Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/study","href":"/api-reference/discovery/get-study-schema"},{"title":"Get Model Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/model","href":"/api-reference/discovery/get-model-schema"},{"title":"Get Pybamm Models","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/pybamm_models","href":"/api-reference/discovery/get-pybamm-models"},{"title":"Validate Pybamm Model Config","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /discovery/pybamm_models/validate","href":"/api-reference/discovery/validate-pybamm-model-config"},{"title":"Serialize Ionworks Model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /discovery/ionworks_models/serialize","href":"/api-reference/discovery/serialize-ionworks-model"},{"title":"Get Parameterized Model Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/parameterized_model","href":"/api-reference/discovery/get-parameterized-model-schema"},{"title":"Get Optimization Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/optimization","href":"/api-reference/discovery/get-optimization-schema"},{"title":"Get Pipeline Schema","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/pipeline","href":"/api-reference/discovery/get-pipeline-schema"},{"title":"Get Simple Pipeline Schema","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /discovery/schemas/simple_pipeline","href":"/api-reference/discovery/get-simple-pipeline-schema"}]},{"group":"Pipeline","pages":[{"title":"Get Validation Plot Data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/validations/{job_id}/plot_data","href":"/api-reference/pipeline/get-validation-plot-data"},{"title":"Get Datafit Plot Data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/datafits/{job_id}/plot_data","href":"/api-reference/pipeline/get-datafit-plot-data"},{"title":"List user's pipelines","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines","href":"/api-reference/pipeline/list-users-pipelines"},{"title":"Create a new pipeline","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /pipelines","href":"/api-reference/pipeline/create-a-new-pipeline"},{"title":"Get pipeline metadata","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/{pipeline_id}","href":"/api-reference/pipeline/get-pipeline-metadata"},{"title":"Get a pipeline element's job_config","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/elements/{element_id}/job_config","href":"/api-reference/pipeline/get-a-pipeline-elements-job_config"},{"title":"Multistart progress for a Data Fit element","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/elements/{element_id}/progress","href":"/api-reference/pipeline/multistart-progress-for-a-data-fit-element"},{"title":"Validation plot manifest for an element","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/elements/{element_id}/validation","href":"/api-reference/pipeline/validation-plot-manifest-for-an-element"},{"title":"Get Pipeline Element Plot Data","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/elements/{element_id}/plot_data","href":"/api-reference/pipeline/get-pipeline-element-plot-data"},{"title":"Get Pipeline Element Plot Data Batch","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/elements/{element_id}/plot_data_batch","href":"/api-reference/pipeline/get-pipeline-element-plot-data-batch"},{"title":"Jobs behind an element (debug view)","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/elements/{element_id}/jobs","href":"/api-reference/pipeline/jobs-behind-an-element-debug-view"},{"title":"Get pipeline result","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /pipelines/{pipeline_id}/result","href":"/api-reference/pipeline/get-pipeline-result"},{"title":"Cancel multiple pipelines","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /pipelines/cancel","href":"/api-reference/pipeline/cancel-multiple-pipelines"},{"title":"Cancel a pipeline","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /pipelines/{pipeline_id}/cancel","href":"/api-reference/pipeline/cancel-a-pipeline"}]},{"group":"simple_pipeline","pages":[{"title":"List SimplePipelines","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simple_pipelines","href":"/api-reference/simple_pipeline/list-simplepipelines"},{"title":"Create and submit a SimplePipeline","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /simple_pipelines","href":"/api-reference/simple_pipeline/create-and-submit-a-simplepipeline"},{"title":"Get SimplePipeline by ID","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /simple_pipelines/{simple_pipeline_id}","href":"/api-reference/simple_pipeline/get-simplepipeline-by-id"},{"title":"Delete a SimplePipeline","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /simple_pipelines/{simple_pipeline_id}","href":"/api-reference/simple_pipeline/delete-a-simplepipeline"},{"title":"Update SimplePipeline name/description","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /simple_pipelines/{simple_pipeline_id}","href":"/api-reference/simple_pipeline/update-simplepipeline-namedescription"},{"title":"Resubmit a SimplePipeline that failed to submit","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /simple_pipelines/{simple_pipeline_id}/resubmit","href":"/api-reference/simple_pipeline/resubmit-a-simplepipeline-that-failed-to-submit"},{"title":"Cancel a running SimplePipeline","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /simple_pipelines/{simple_pipeline_id}/cancel","href":"/api-reference/simple_pipeline/cancel-a-running-simplepipeline"}]},{"group":"protocols","pages":[{"title":"Validate Protocol Endpoint","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /protocols/validate","href":"/api-reference/protocols/validate-protocol-endpoint"},{"title":"Generate Protocol Endpoint","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /protocols/generate","href":"/api-reference/protocols/generate-protocol-endpoint"},{"title":"Check Protocol Name Endpoint","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /protocols/check_name","href":"/api-reference/protocols/check-protocol-name-endpoint"},{"title":"Convert Protocol Endpoint","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /protocols/convert","href":"/api-reference/protocols/convert-protocol-endpoint"},{"title":"Compare Protocols Endpoint","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /protocols/compare","href":"/api-reference/protocols/compare-protocols-endpoint"},{"title":"Find Input References Endpoint","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /protocols/input_references","href":"/api-reference/protocols/find-input-references-endpoint"}]},{"group":"users","pages":[{"title":"Get Current User Profile","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /users/me","href":"/api-reference/users/get-current-user-profile"}]},{"group":"jobs","pages":[{"title":"List Jobs","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Submit Job","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /jobs","href":"/api-reference/jobs/submit-job"},{"title":"Get Job","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /jobs/{job_id}","href":"/api-reference/jobs/get-job"},{"title":"Get Job Metadata","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /jobs/{job_id}/metadata","href":"/api-reference/jobs/get-job-metadata"},{"title":"Get Job Metadata Summary","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /jobs/{job_id}/metadata_summary","href":"/api-reference/jobs/get-job-metadata-summary"},{"title":"Get Job Validation Series Channels","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /jobs/{job_id}/series/channels","href":"/api-reference/jobs/get-job-validation-series-channels"},{"title":"Get Job Validation Series","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /jobs/{job_id}/series","href":"/api-reference/jobs/get-job-validation-series"},{"title":"Cancel Job","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /jobs/{job_id}/cancel","href":"/api-reference/jobs/cancel-job"}]},{"group":"optimization","pages":[{"title":"Get Optimization With Jobs","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimize","href":"/api-reference/optimization/get-optimization-with-jobs"},{"title":"Get Optimization With Job","deprecated":true,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimize/{id}","href":"/api-reference/optimization/get-optimization-with-job"}]},{"group":"optimizations","pages":[{"title":"List Optimization Resources","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations","href":"/api-reference/optimizations/list-optimization-resources"},{"title":"Submit Optimization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /optimizations","href":"/api-reference/optimizations/submit-optimization"},{"title":"Get Optimization Resource","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/{id}","href":"/api-reference/optimizations/get-optimization-resource"},{"title":"Update Optimization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /optimizations/{id}","href":"/api-reference/optimizations/update-optimization"},{"title":"Cancel Optimization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /optimizations/{id}/cancel","href":"/api-reference/optimizations/cancel-optimization"},{"title":"Resubmit Optimization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /optimizations/{id}/resubmit","href":"/api-reference/optimizations/resubmit-optimization"},{"title":"Get Optimization Resource Statuses","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/statuses","href":"/api-reference/optimizations/get-optimization-resource-statuses"},{"title":"List Optimization Runs","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/{id}/runs","href":"/api-reference/optimizations/list-optimization-runs"},{"title":"Get Optimization Config","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/{id}/config","href":"/api-reference/optimizations/get-optimization-config"},{"title":"Get Optimization Series Channels","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/{id}/series/channels","href":"/api-reference/optimizations/get-optimization-series-channels"},{"title":"Get Optimization Series","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/{id}/series","href":"/api-reference/optimizations/get-optimization-series"},{"title":"Get Optimization Metadata","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /optimizations/{id}/metadata","href":"/api-reference/optimizations/get-optimization-metadata"}]},{"group":"Organizations","pages":[{"title":"Current organization usage and limits for the active billing period","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /organizations/current/usage","href":"/api-reference/organizations/current-organization-usage-and-limits-for-the-active-billing-period"}]},{"group":"API Reference","pages":[{"title":"List projects for an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects","href":"/api-reference/list-projects-for-an-organization"},{"title":"Create a new project within an organization, assigning creator as Project Admin","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects","href":"/api-reference/create-a-new-project-within-an-organization-assigning-creator-as-project-admin"},{"title":"Get a specific project by ID within an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}","href":"/api-reference/get-a-specific-project-by-id-within-an-organization"},{"title":"Delete a project from an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}","href":"/api-reference/delete-a-project-from-an-organization"},{"title":"Update a project within an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /projects/{project_id}","href":"/api-reference/update-a-project-within-an-organization"},{"title":"Add a user to a project or update their project role","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/members","href":"/api-reference/add-a-user-to-a-project-or-update-their-project-role"},{"title":"Invite a user to a project by email","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/invites","href":"/api-reference/invite-a-user-to-a-project-by-email"},{"title":"Remove a user from a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}/members/{user_id}","href":"/api-reference/remove-a-user-from-a-project"},{"title":"Update a user's project role","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /projects/{project_id}/members/{user_id}","href":"/api-reference/update-a-users-project-role"},{"title":"List models for a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /models","href":"/api-reference/list-models-for-a-project"},{"title":"Create a new model within an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /models","href":"/api-reference/create-a-new-model-within-an-organization"},{"title":"Get a specific model by ID within an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /models/{model_id}","href":"/api-reference/get-a-specific-model-by-id-within-an-organization"},{"title":"Delete a model from an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /models/{model_id}","href":"/api-reference/delete-a-model-from-an-organization"},{"title":"Update a model within an organization","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /models/{model_id}","href":"/api-reference/update-a-model-within-an-organization"},{"title":"Add a custom variable to an existing model","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /models/{model_id}/custom-variables","href":"/api-reference/add-a-custom-variable-to-an-existing-model"}]},{"group":"project-webhooks","pages":[{"title":"List webhooks for a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/webhooks","href":"/api-reference/project-webhooks/list-webhooks-for-a-project"},{"title":"Create a project webhook","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/webhooks","href":"/api-reference/project-webhooks/create-a-project-webhook"},{"title":"Delete a project webhook","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}/webhooks/{webhook_id}","href":"/api-reference/project-webhooks/delete-a-project-webhook"},{"title":"Update a project webhook","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /projects/{project_id}/webhooks/{webhook_id}","href":"/api-reference/project-webhooks/update-a-project-webhook"},{"title":"Enqueue a test webhook delivery","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/webhooks/{webhook_id}/test","href":"/api-reference/project-webhooks/enqueue-a-test-webhook-delivery"},{"title":"List recent deliveries for a webhook","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/webhooks/{webhook_id}/deliveries","href":"/api-reference/project-webhooks/list-recent-deliveries-for-a-webhook"}]},{"group":"Model builders","pages":[{"title":"List model builders","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /model_builders","href":"/api-reference/model-builders/list-model-builders"},{"title":"Create a model builder","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders","href":"/api-reference/model-builders/create-a-model-builder"},{"title":"List calculations a model builder can use","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /model_builders/calculations","href":"/api-reference/model-builders/list-calculations-a-model-builder-can-use"},{"title":"Inputs and outputs of configured calculations","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders/calculations/io","href":"/api-reference/model-builders/inputs-and-outputs-of-configured-calculations"},{"title":"Calculations that produce a parameter","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /model_builders/calculations/producing","href":"/api-reference/model-builders/calculations-that-produce-a-parameter"},{"title":"Preview a cell-spec mapping and its unit conversion","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders/preview_mapping","href":"/api-reference/model-builders/preview-a-cell-spec-mapping-and-its-unit-conversion"},{"title":"Run an unsaved model builder config against a cell spec","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders/dry_run","href":"/api-reference/model-builders/run-an-unsaved-model-builder-config-against-a-cell-spec"},{"title":"Suggest a source for every model parameter with AI","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders/suggest","href":"/api-reference/model-builders/suggest-a-source-for-every-model-parameter-with-ai"},{"title":"Get a model builder","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /model_builders/{model_builder_id}","href":"/api-reference/model-builders/get-a-model-builder"},{"title":"Delete a model builder","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /model_builders/{model_builder_id}","href":"/api-reference/model-builders/delete-a-model-builder"},{"title":"Update a model builder","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /model_builders/{model_builder_id}","href":"/api-reference/model-builders/update-a-model-builder"},{"title":"Check a cell spec is ready for a model builder","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders/{model_builder_id}/check","href":"/api-reference/model-builders/check-a-cell-spec-is-ready-for-a-model-builder"},{"title":"Build a parameter set from a cell spec","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /model_builders/{model_builder_id}/build","href":"/api-reference/model-builders/build-a-parameter-set-from-a-cell-spec"},{"title":"Get the resolved document model builders read from a cell spec","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications/{cell_spec_id}/resolved","href":"/api-reference/model-builders/get-the-resolved-document-model-builders-read-from-a-cell-spec"},{"title":"Check a cell spec against every model builder","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /cell_specifications/{cell_spec_id}/builder_readiness","href":"/api-reference/model-builders/check-a-cell-spec-against-every-model-builder"}]},{"group":"studies","pages":[{"title":"List studies for a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/studies","href":"/api-reference/studies/list-studies-for-a-project"},{"title":"Create a new study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/studies","href":"/api-reference/studies/create-a-new-study"},{"title":"Get a specific study by ID","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/studies/{study_id}","href":"/api-reference/studies/get-a-specific-study-by-id"},{"title":"Delete a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}/studies/{study_id}","href":"/api-reference/studies/delete-a-study"},{"title":"Update a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /projects/{project_id}/studies/{study_id}","href":"/api-reference/studies/update-a-study"},{"title":"Assign a simulation to a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/studies/{study_id}/simulations/{simulation_id}","href":"/api-reference/studies/assign-a-simulation-to-a-study"},{"title":"Remove a simulation from a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}/studies/{study_id}/simulations/{simulation_id}","href":"/api-reference/studies/remove-a-simulation-from-a-study"},{"title":"Assign a measurement to a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/studies/{study_id}/measurements/{measurement_id}","href":"/api-reference/studies/assign-a-measurement-to-a-study"},{"title":"Remove a measurement from a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}/studies/{study_id}/measurements/{measurement_id}","href":"/api-reference/studies/remove-a-measurement-from-a-study"},{"title":"List measurements assigned to a study","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/studies/{study_id}/measurements","href":"/api-reference/studies/list-measurements-assigned-to-a-study"}]},{"group":"Lab","pages":[{"title":"Get the lab-view occupancy status for a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/lab/status","href":"/api-reference/lab/get-the-lab-view-occupancy-status-for-a-project"},{"title":"Build a lab status report for a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/lab/report","href":"/api-reference/lab/build-a-lab-status-report-for-a-project"},{"title":"Get a project's channel-hours by state per calendar period","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/lab/utilization-history","href":"/api-reference/lab/get-a-projects-channel-hours-by-state-per-calendar-period"},{"title":"List the measurement IDs the current user is watching","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/lab/watched","href":"/api-reference/lab/list-the-measurement-ids-the-current-user-is-watching"}]},{"group":"Planned Measurements","pages":[{"title":"List planned measurements for a project","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/planned_measurements","href":"/api-reference/planned-measurements/list-planned-measurements-for-a-project"},{"title":"Create a planned measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/planned_measurements","href":"/api-reference/planned-measurements/create-a-planned-measurement"},{"title":"Earliest free start time on a channel","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/planned_measurements/next_available","href":"/api-reference/planned-measurements/earliest-free-start-time-on-a-channel"},{"title":"Propose reservations for selected requested tests","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/planned_measurements/auto_schedule_proposal","href":"/api-reference/planned-measurements/propose-reservations-for-selected-requested-tests"},{"title":"Apply selected auto-schedule assignments","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json post /projects/{project_id}/planned_measurements/apply_auto_schedule_proposal","href":"/api-reference/planned-measurements/apply-selected-auto-schedule-assignments"},{"title":"Get a planned measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/planned_measurements/{planned_measurement_id}","href":"/api-reference/planned-measurements/get-a-planned-measurement"},{"title":"Delete a planned measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json delete /projects/{project_id}/planned_measurements/{planned_measurement_id}","href":"/api-reference/planned-measurements/delete-a-planned-measurement"},{"title":"Update a planned measurement","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /projects/{project_id}/planned_measurements/{planned_measurement_id}","href":"/api-reference/planned-measurements/update-a-planned-measurement"},{"title":"Voltage and current bounds a planned measurement's protocol implies","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /projects/{project_id}/planned_measurements/{planned_measurement_id}/electrical_limits","href":"/api-reference/planned-measurements/voltage-and-current-bounds-a-planned-measurements-protocol-implies"},{"title":"Estimate a planned measurement's duration from its protocol","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json patch /projects/{project_id}/planned_measurements/{planned_measurement_id}/estimate_duration","href":"/api-reference/planned-measurements/estimate-a-planned-measurements-duration-from-its-protocol"}]},{"group":"Health check","pages":[{"title":"Health Check","deprecated":null,"version":null,"openapi":"https://api.ionworks.com/openapi.json get /healthz","href":"/api-reference/health-check/health-check"}]}]}]},"basePath":"","title":"Create Simulation Batch With Template - Ionworks Studio","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}