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,
arbin_sdx,
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
verify
boolean
default:false

Round-trip the emitted file back through its parser and refuse the conversion (400) if the protocol no longer means the same thing. A writer that drops a loop count, a goto, or a safety bound emits a valid file that simulates identically, so the loss would otherwise only show up on hardware. A re-encoding the target format forces — a C-rate resolved to absolute amps on a format with no C-rate type — is allowed. Off by default: the checker still reports two benign round-trip artifacts of Maccor/Arbin/Neware (explicit fall-through gotos and an appended terminal step) as differences, so enabling it by default would refuse most valid conversions to those targets.

Response

Successful Response

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