Validate Protocol Endpoint

Validate a protocol dictionary.

Runs the full backend validation (Pydantic model checks, termination condition inheritance, operator consistency, duplicate names, etc.) and returns the result.

Parameters

body : ValidateProtocolRequest Request containing the protocol dict to validate

Returns

dict {"valid": true} on success, or {"valid": false, "error": "..."} on failure.

Validate Protocol Endpoint

cURL

curl --request POST \
  --url https://api.ionworks.com/protocols/validate \
  --header 'Content-Type: application/json' \
  --data '{
  "protocol": {}
}'

200

{}

Body

application/json

Request body for validating a protocol.

protocol · Protocol · object string · required

Protocol as a YAML-format dictionary with 'steps' and optional 'global', 'safety_limits', or a YAML string.

Response

200

application/json

Successful Response

The response is of type Response Validate Protocol Endpoint Protocols Validate Post · object.