Convert Protocol Endpoint

Convert a UCP to a vendor-native protocol file.

The primary artifact is returned as base64-encoded bytes alongside a suggested filename and media type. Some targets (currently Maccor with drive cycles) emit additional asset files in assets.

Convert Protocol Endpoint

cURL

curl --request POST \
  --url https://api.ionworks.com/protocols/convert \
  --header 'Content-Type: application/json' \
  --data '
{
  "protocol": {},
  "drive_cycles": {},
  "filename_stem": "protocol",
  "nominal_capacity_ah": 1
}
'

200

{
  "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 · Protocol · object string · 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 | null

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).

nominal_capacity_ah · number | null

Rated cell capacity in A.h, from the cell specification. Required for 'neware' when the protocol uses C-rate steps or cutoffs: Neware sets current in absolute mA and has no C-rate mode, so the rate cannot be resolved without it. Ignored by other targets, which express C-rate natively.

Required range: x > 0

Response

200

application/json

Successful Response

target · string · required

primary · ConvertedFile · object · required

Show child attributes

assets · ConvertedFile · object[]

Show child attributes