Skip to main content
Create Experiment Template
curl --request POST \
  --url https://api.ionworks.com/experiment_templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "protocol_config": {},
  "description": "<string>",
  "parameters_schema": {},
  "time_series_spec": {},
  "metrics_spec": {},
  "source_protocol": "<string>",
  "force_create": false
}
'
{
  "name": "<string>",
  "organization_id": "<string>",
  "id": "<string>",
  "description": "<string>",
  "description_template": "<string>",
  "protocol_config": {},
  "parameters_schema": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "plot_options": {},
  "time_series_spec": {},
  "metrics_spec": {},
  "source_protocol": "<string>",
  "created_by": "<string>",
  "created_by_email": "<string>"
}

Body

application/json

Request body for creating an experiment template.

​
name
string
required
​
protocol_config
Protocol Config · object
required
​
description
string | null
​
parameters_schema
Parameters Schema · object
​
time_series_spec
Time Series Spec · object
​
metrics_spec
Metrics Spec · object
​
source_protocol
string | null
​
force_create
boolean
default:false

Response

Successful Response

Pydantic model for experiment template database entity.

​
name
string
required

Name of the template

​
organization_id
string
required

ID of the organization that owns this template

​
id
string | null

Unique identifier for the template

​
description
string | null

Description of the template

​
description_template
string | null

Template string for generating user-facing descriptions with {{param}} placeholders

​
protocol_config
Protocol Config · object

Protocol configuration (UCP format). Omitted from list responses by default; opt in via ?include=protocol_config.

​
parameters_schema
Parameters Schema · object

Parameters schema defining what parameters this template accepts. Omitted from list responses by default; opt in via ?include=parameters_schema.

​
created_at
string | null

When the template was created

​
updated_at
string | null

When the template was last updated

​
plot_options
Plot Options · object

Plot configuration options organized by plot type (time_series, metrics)

​
time_series_spec
Time Series Spec · object

Specification mapping time-series keys to calculation rules.

​
metrics_spec
Metrics Spec · object

Specification mapping metric names to calculation rules.

​
source_protocol
string | null

Original protocol text as entered by the user

​
created_by
string | null

User ID of the user who created this template

​
created_by_email
string | null

Email of the user who created this template