Skip to content

Lifecycle

Base URL: https://app.trymaglev.com/api/v1. All endpoint families.

The hardware lifecycle as Maglev’s playbooks define it: 35 stages in six phases, each with inputs, outputs, Maglev’s role, the action kinds that run it, and its availability today.

Required scope: lifecycle:read.

Authentication: bearer key.

200 response schema
{
"type": "object",
"properties": {
"phases": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Stage"
}
},
"counts": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"coordinated": {
"type": "integer"
},
"planned": {
"type": "integer"
}
}
}
}
}

Errors: 400 Validation error; 401 Missing or invalid key; 403 Scope or mode does not allow this; 404 Not found; 429 Rate limit reached. See recovery guidance.

One stage, with an example request body for its action kinds.

Required scope: lifecycle:read.

Authentication: bearer key.

Parameter Location Required Details
stageId path Yes
200 response schema
{
"type": "object",
"properties": {
"stage": {
"$ref": "#/components/schemas/Stage"
},
"howToRequest": {
"type": "object",
"properties": {}
}
}
}

Errors: 400 Validation error; 401 Missing or invalid key; 403 Scope or mode does not allow this; 404 Not found; 429 Rate limit reached. See recovery guidance.

Every action kind with its JSON schema for input and output, availability and stage ids. Also listed under x-action-kinds in this document.

Required scope: lifecycle:read.

Authentication: bearer key.

200 response schema
{
"type": "object",
"properties": {
"kinds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"availability": {
"type": "string"
},
"stageIds": {
"type": "array",
"items": {
"type": "string"
}
},
"cost": {
"type": "string"
},
"inputSchema": {
"type": "object"
},
"outputSchema": {
"type": "object"
}
},
"required": [
"kind",
"name",
"description",
"availability",
"stageIds",
"cost",
"inputSchema",
"outputSchema"
]
}
},
"count": {
"type": "integer"
},
"note": {
"type": "string"
},
"requestId": {
"type": "string"
}
},
"required": [
"kinds",
"count",
"note",
"requestId"
]
}

Errors: 401 Invalid key or missing sign-in; 403 Insufficient access; 429 Rate limit reached; 500 Server failure. See recovery guidance.

Stage · Error