Skip to content

Compliance path

A product-specific planning table and draft explanation.

All action kinds · Project workflow

  • Kind: compliance_path
  • Availability: available
  • Registry cost category: one_call
  • Lifecycle stage IDs: regulatory_and_certification, compliance_documentation

The cost category describes model work in the registry; it is not a manufacturing price or a monetary quote. Read maglev actions kinds --json for current availability and schemas.

Returns planning information and a draft explanation. It does not certify a product or replace review of current requirements for the actual product and market.

Send these fields inside the request’s input object. Use only facts you have, and keep unresolved requirements explicit. Optional fields with defaults can be omitted.

Field Type Required Details
product string Yes Min length 2. Max length 400
markets string[] No Max items 10. Default: [“US”]
radios string[] No Max items 10
moduleIsPreCertified boolean,null No
battery string No One of: none, liion_contained, liion_pack, other. Default: “none”
mainsPowered boolean No
laser boolean No
childrensProduct boolean No
medical boolean No
Input JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"product": {
"type": "string",
"minLength": 2,
"maxLength": 400
},
"markets": {
"default": [
"US"
],
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 2,
"maxLength": 8
}
},
"radios": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 2,
"maxLength": 40
}
},
"moduleIsPreCertified": {
"type": [
"boolean",
"null"
]
},
"battery": {
"default": "none",
"type": "string",
"enum": [
"none",
"liion_contained",
"liion_pack",
"other"
]
},
"mainsPowered": {
"type": "boolean"
},
"laser": {
"type": "boolean"
},
"childrensProduct": {
"type": "boolean"
},
"medical": {
"type": "boolean"
}
},
"required": [
"product"
]
}

Prepare action.json with kind: "compliance_path" and an input object matching the schema above.

Replace PROJECT_ID with your saved project ID. Use a new idempotency key for new work and retain it for an identical retry.

Terminal window
maglev actions request PROJECT_ID --input action.json \
--idempotency-key example-compliance-path-001 --json

Read action.status, action.output, deliveries and any task in the response. Model actions can take several minutes. After a timeout, check saved actions before retrying. See request and recovery behavior.

The schema below describes action.output.result. The saved action.output envelope also contains draft: true and a note. It can be null while an action is running or after a failure; check the status before reading the result. Null or missing facts are unknown; preserve source references and open questions.

This action currently exports an open object schema. Inspect its returned fields and status; an open schema is not a guarantee that a particular field will exist.

Output JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": {}
}