Create Simulation Batch With Template
curl --request POST \
--url https://api.ionworks.com/simulations/with-template/batch \
--header 'Content-Type: application/json' \
--data '
{
"parameterized_model": {},
"experiment_template_id": "<string>",
"conditions": [
{
"experiment_parameters": {},
"design_parameters": {}
}
],
"experiment_parameter_sets": [
{}
],
"experiment_conditions": [
{}
],
"design_parameters_doe": {
"sampling": "grid",
"rows": [
{
"name": "<string>",
"type": "discrete",
"values": [
123
]
}
],
"count": 123
},
"study_id": "<string>",
"max_backward_jumps": 123,
"extra_variables": [
"<string>"
],
"variable_callback_rules": [
{}
],
"termination_condition_rules": [
{}
],
"treat_pause_as_rest": true,
"force_rerun": false
}
'import requests
url = "https://api.ionworks.com/simulations/with-template/batch"
payload = {
"parameterized_model": {},
"experiment_template_id": "<string>",
"conditions": [
{
"experiment_parameters": {},
"design_parameters": {}
}
],
"experiment_parameter_sets": [{}],
"experiment_conditions": [{}],
"design_parameters_doe": {
"sampling": "grid",
"rows": [
{
"name": "<string>",
"type": "discrete",
"values": [123]
}
],
"count": 123
},
"study_id": "<string>",
"max_backward_jumps": 123,
"extra_variables": ["<string>"],
"variable_callback_rules": [{}],
"termination_condition_rules": [{}],
"treat_pause_as_rest": True,
"force_rerun": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
parameterized_model: {},
experiment_template_id: '<string>',
conditions: [{experiment_parameters: {}, design_parameters: {}}],
experiment_parameter_sets: [{}],
experiment_conditions: [{}],
design_parameters_doe: {
sampling: 'grid',
rows: [{name: '<string>', type: 'discrete', values: [123]}],
count: 123
},
study_id: '<string>',
max_backward_jumps: 123,
extra_variables: ['<string>'],
variable_callback_rules: [{}],
termination_condition_rules: [{}],
treat_pause_as_rest: true,
force_rerun: false
})
};
fetch('https://api.ionworks.com/simulations/with-template/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/simulations/with-template/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parameterized_model' => [
],
'experiment_template_id' => '<string>',
'conditions' => [
[
'experiment_parameters' => [
],
'design_parameters' => [
]
]
],
'experiment_parameter_sets' => [
[
]
],
'experiment_conditions' => [
[
]
],
'design_parameters_doe' => [
'sampling' => 'grid',
'rows' => [
[
'name' => '<string>',
'type' => 'discrete',
'values' => [
123
]
]
],
'count' => 123
],
'study_id' => '<string>',
'max_backward_jumps' => 123,
'extra_variables' => [
'<string>'
],
'variable_callback_rules' => [
[
]
],
'termination_condition_rules' => [
[
]
],
'treat_pause_as_rest' => true,
'force_rerun' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simulations/with-template/batch"
payload := strings.NewReader("{\n \"parameterized_model\": {},\n \"experiment_template_id\": \"<string>\",\n \"conditions\": [\n {\n \"experiment_parameters\": {},\n \"design_parameters\": {}\n }\n ],\n \"experiment_parameter_sets\": [\n {}\n ],\n \"experiment_conditions\": [\n {}\n ],\n \"design_parameters_doe\": {\n \"sampling\": \"grid\",\n \"rows\": [\n {\n \"name\": \"<string>\",\n \"type\": \"discrete\",\n \"values\": [\n 123\n ]\n }\n ],\n \"count\": 123\n },\n \"study_id\": \"<string>\",\n \"max_backward_jumps\": 123,\n \"extra_variables\": [\n \"<string>\"\n ],\n \"variable_callback_rules\": [\n {}\n ],\n \"termination_condition_rules\": [\n {}\n ],\n \"treat_pause_as_rest\": true,\n \"force_rerun\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/simulations/with-template/batch")
.header("Content-Type", "application/json")
.body("{\n \"parameterized_model\": {},\n \"experiment_template_id\": \"<string>\",\n \"conditions\": [\n {\n \"experiment_parameters\": {},\n \"design_parameters\": {}\n }\n ],\n \"experiment_parameter_sets\": [\n {}\n ],\n \"experiment_conditions\": [\n {}\n ],\n \"design_parameters_doe\": {\n \"sampling\": \"grid\",\n \"rows\": [\n {\n \"name\": \"<string>\",\n \"type\": \"discrete\",\n \"values\": [\n 123\n ]\n }\n ],\n \"count\": 123\n },\n \"study_id\": \"<string>\",\n \"max_backward_jumps\": 123,\n \"extra_variables\": [\n \"<string>\"\n ],\n \"variable_callback_rules\": [\n {}\n ],\n \"termination_condition_rules\": [\n {}\n ],\n \"treat_pause_as_rest\": true,\n \"force_rerun\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simulations/with-template/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"parameterized_model\": {},\n \"experiment_template_id\": \"<string>\",\n \"conditions\": [\n {\n \"experiment_parameters\": {},\n \"design_parameters\": {}\n }\n ],\n \"experiment_parameter_sets\": [\n {}\n ],\n \"experiment_conditions\": [\n {}\n ],\n \"design_parameters_doe\": {\n \"sampling\": \"grid\",\n \"rows\": [\n {\n \"name\": \"<string>\",\n \"type\": \"discrete\",\n \"values\": [\n 123\n ]\n }\n ],\n \"count\": 123\n },\n \"study_id\": \"<string>\",\n \"max_backward_jumps\": 123,\n \"extra_variables\": [\n \"<string>\"\n ],\n \"variable_callback_rules\": [\n {}\n ],\n \"termination_condition_rules\": [\n {}\n ],\n \"treat_pause_as_rest\": true,\n \"force_rerun\": false\n}"
response = http.request(request)
puts response.read_body[
{
"simulation_id": "<string>",
"job_id": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Simulations
Create Simulation Batch With Template
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
Create Simulation Batch With Template
curl --request POST \
--url https://api.ionworks.com/simulations/with-template/batch \
--header 'Content-Type: application/json' \
--data '
{
"parameterized_model": {},
"experiment_template_id": "<string>",
"conditions": [
{
"experiment_parameters": {},
"design_parameters": {}
}
],
"experiment_parameter_sets": [
{}
],
"experiment_conditions": [
{}
],
"design_parameters_doe": {
"sampling": "grid",
"rows": [
{
"name": "<string>",
"type": "discrete",
"values": [
123
]
}
],
"count": 123
},
"study_id": "<string>",
"max_backward_jumps": 123,
"extra_variables": [
"<string>"
],
"variable_callback_rules": [
{}
],
"termination_condition_rules": [
{}
],
"treat_pause_as_rest": true,
"force_rerun": false
}
'import requests
url = "https://api.ionworks.com/simulations/with-template/batch"
payload = {
"parameterized_model": {},
"experiment_template_id": "<string>",
"conditions": [
{
"experiment_parameters": {},
"design_parameters": {}
}
],
"experiment_parameter_sets": [{}],
"experiment_conditions": [{}],
"design_parameters_doe": {
"sampling": "grid",
"rows": [
{
"name": "<string>",
"type": "discrete",
"values": [123]
}
],
"count": 123
},
"study_id": "<string>",
"max_backward_jumps": 123,
"extra_variables": ["<string>"],
"variable_callback_rules": [{}],
"termination_condition_rules": [{}],
"treat_pause_as_rest": True,
"force_rerun": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
parameterized_model: {},
experiment_template_id: '<string>',
conditions: [{experiment_parameters: {}, design_parameters: {}}],
experiment_parameter_sets: [{}],
experiment_conditions: [{}],
design_parameters_doe: {
sampling: 'grid',
rows: [{name: '<string>', type: 'discrete', values: [123]}],
count: 123
},
study_id: '<string>',
max_backward_jumps: 123,
extra_variables: ['<string>'],
variable_callback_rules: [{}],
termination_condition_rules: [{}],
treat_pause_as_rest: true,
force_rerun: false
})
};
fetch('https://api.ionworks.com/simulations/with-template/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/simulations/with-template/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'parameterized_model' => [
],
'experiment_template_id' => '<string>',
'conditions' => [
[
'experiment_parameters' => [
],
'design_parameters' => [
]
]
],
'experiment_parameter_sets' => [
[
]
],
'experiment_conditions' => [
[
]
],
'design_parameters_doe' => [
'sampling' => 'grid',
'rows' => [
[
'name' => '<string>',
'type' => 'discrete',
'values' => [
123
]
]
],
'count' => 123
],
'study_id' => '<string>',
'max_backward_jumps' => 123,
'extra_variables' => [
'<string>'
],
'variable_callback_rules' => [
[
]
],
'termination_condition_rules' => [
[
]
],
'treat_pause_as_rest' => true,
'force_rerun' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simulations/with-template/batch"
payload := strings.NewReader("{\n \"parameterized_model\": {},\n \"experiment_template_id\": \"<string>\",\n \"conditions\": [\n {\n \"experiment_parameters\": {},\n \"design_parameters\": {}\n }\n ],\n \"experiment_parameter_sets\": [\n {}\n ],\n \"experiment_conditions\": [\n {}\n ],\n \"design_parameters_doe\": {\n \"sampling\": \"grid\",\n \"rows\": [\n {\n \"name\": \"<string>\",\n \"type\": \"discrete\",\n \"values\": [\n 123\n ]\n }\n ],\n \"count\": 123\n },\n \"study_id\": \"<string>\",\n \"max_backward_jumps\": 123,\n \"extra_variables\": [\n \"<string>\"\n ],\n \"variable_callback_rules\": [\n {}\n ],\n \"termination_condition_rules\": [\n {}\n ],\n \"treat_pause_as_rest\": true,\n \"force_rerun\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/simulations/with-template/batch")
.header("Content-Type", "application/json")
.body("{\n \"parameterized_model\": {},\n \"experiment_template_id\": \"<string>\",\n \"conditions\": [\n {\n \"experiment_parameters\": {},\n \"design_parameters\": {}\n }\n ],\n \"experiment_parameter_sets\": [\n {}\n ],\n \"experiment_conditions\": [\n {}\n ],\n \"design_parameters_doe\": {\n \"sampling\": \"grid\",\n \"rows\": [\n {\n \"name\": \"<string>\",\n \"type\": \"discrete\",\n \"values\": [\n 123\n ]\n }\n ],\n \"count\": 123\n },\n \"study_id\": \"<string>\",\n \"max_backward_jumps\": 123,\n \"extra_variables\": [\n \"<string>\"\n ],\n \"variable_callback_rules\": [\n {}\n ],\n \"termination_condition_rules\": [\n {}\n ],\n \"treat_pause_as_rest\": true,\n \"force_rerun\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simulations/with-template/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"parameterized_model\": {},\n \"experiment_template_id\": \"<string>\",\n \"conditions\": [\n {\n \"experiment_parameters\": {},\n \"design_parameters\": {}\n }\n ],\n \"experiment_parameter_sets\": [\n {}\n ],\n \"experiment_conditions\": [\n {}\n ],\n \"design_parameters_doe\": {\n \"sampling\": \"grid\",\n \"rows\": [\n {\n \"name\": \"<string>\",\n \"type\": \"discrete\",\n \"values\": [\n 123\n ]\n }\n ],\n \"count\": 123\n },\n \"study_id\": \"<string>\",\n \"max_backward_jumps\": 123,\n \"extra_variables\": [\n \"<string>\"\n ],\n \"variable_callback_rules\": [\n {}\n ],\n \"termination_condition_rules\": [\n {}\n ],\n \"treat_pause_as_rest\": true,\n \"force_rerun\": false\n}"
response = http.request(request)
puts response.read_body[
{
"simulation_id": "<string>",
"job_id": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Request body for creating multiple simulations with single model/template.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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
Show child attributes
Was this page helpful?
⌘I