Parse Protocol To Template

curl --request POST \
  --url https://api.ionworks.com/protocols/parse-to-template \
  --header 'Content-Type: application/json' \
  --data '
{
  "protocol_experiment": {
    "protocol": "<string>",
    "name": "<string>",
    "additional_content_files": {},
    "parameters_schema": {}
  },
  "experiment_parameters": {}
}
'

{
  "template_id": "<string>"
}

Parse Protocol To Template

Parse a raw protocol string and create (or find) a canonical experiment template.

This is the first step of a two-step protocol submission flow. Call this to resolve a template_id, then pass that ID to POST /simulations/with-template/batch to run simulations.

Parameters

body : ParseToTemplateRequest Protocol text, name, optional drive cycle files, and experiment parameters.

Returns

ParseToTemplateResponse The UUID of the resolved (created or existing) experiment template.

Parse Protocol To Template

curl --request POST \
  --url https://api.ionworks.com/protocols/parse-to-template \
  --header 'Content-Type: application/json' \
  --data '
{
  "protocol_experiment": {
    "protocol": "<string>",
    "name": "<string>",
    "additional_content_files": {},
    "parameters_schema": {}
  },
  "experiment_parameters": {}
}
'

{
  "template_id": "<string>"
}

Body

application/json

Request body for parsing a raw protocol and creating an experiment template.

protocol_experiment

ProtocolExperimentConfig · object

required

Experiment configuration using protocol string or Protocol object.

Show child attributes

experiment_parameters

Experiment Parameters · object

Response

Successful Response

Response from the parse-to-template endpoint.

template_id

string

required

⌘I