Skip to main content
Convert Protocol Endpoint
curl --request POST \
  --url https://api.ionworks.com/protocols/convert \
  --header 'Content-Type: application/json' \
  --data '
{
  "protocol": {},
  "drive_cycles": {},
  "filename_stem": "protocol"
}
'
{
  "target": "<string>",
  "primary": {
    "filename": "<string>",
    "content_base64": "<string>",
    "media_type": "<string>"
  },
  "assets": [
    {
      "filename": "<string>",
      "content_base64": "<string>",
      "media_type": "<string>"
    }
  ]
}

Body

application/json

Request body for converting a UCP to a vendor-native protocol file.

protocol
required

UCP as a dict or YAML string.

target
enum<string>
required

Vendor target: 'maccor', 'arbin', 'neware', 'biologic_bttest', or 'novonix'.

Available options:
maccor,
arbin,
neware,
biologic_bttest,
novonix
drive_cycles
Drive Cycles · object

Optional mapping of drive cycle name → samples. Required when the protocol references DriveCycle steps.

filename_stem
string
default:protocol

Stem for the returned primary filename (no extension).

Response

Successful Response

target
string
required
primary
ConvertedFile · object
required
assets
ConvertedFile · object[]