Skip to main content
Convert Protocol Endpoint

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

Response

Successful Response

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