DocumentationAPI v1
Organisation workloads
List, create, edit and transition workloads in your organisation's register over HTTP, including reversible pausing and permanent archiving that free active workload slots without erasing decision history.
GET /api/v1/org/workloads
POST /api/v1/org/workloads
GET /api/v1/org/workloads/{slug}
POST /api/v1/org/workloads/{slug}Authorization: Bearer vitna_push_...curl -H "authorization: Bearer vitna_push_..." https://vitna.ai/api/v1/org/workloads
curl -X POST https://vitna.ai/api/v1/org/workloads \
-H "authorization: Bearer vitna_push_..." \
-H "content-type: application/json" \
-d '{
"slug": "support-triage",
"name": "Support triage",
"classId": "model",
"incumbentSkuId": "openai/gpt-5.6-luna",
"unitLabel": "ticket",
"unitProfile": { "inputTokensPerUnit": 1800, "outputTokensPerUnit": 400 },
"priority": "economics"
}'Scopes and plan allowance
Reads (GET) accept either a platform or push key. Writes (POST) require a platform key (vitna_key_...; router keys are refused with 403 forbidden_scope).
Every workload carries a status in active, paused or archived:
activeworkloads count against the organisation's metered allowance (1on Free,3on Deploy, unmetered under an operator agreement).pausedworkloads stop counting toward the active allowance while retaining all standing decisions, lane rules and measurements. Resuming (pausedtoactive) checks the active allowance inside the write transaction and answers402 plan_allowance_exceededif all slots are full.archivedworkloads permanently retire a lane while keeping its audit trail intact (409 workload_archivedif asked to re-activate).
Response shape
{
"data": [
{
"id": "convexity/support-triage",
"orgId": "convexity",
"slug": "support-triage",
"name": "Support triage",
"classId": "model",
"incumbentSkuId": "openai/gpt-5.6-luna",
"incumbentIsPrivate": false,
"unitLabel": "ticket",
"unitProfile": { "inputTokensPerUnit": 1800, "outputTokensPerUnit": 400 },
"monthlyVolume": null,
"constraints": {},
"delivery": {},
"priority": "economics",
"notes": null,
"status": "active",
"pausedAt": null,
"archivedAt": null,
"activeRuleCount": 0,
"activeFallbackCount": 0,
"decisionCount": 1
}
],
"meta": {
"generatedAt": "2026-09-14T12:00:00.000Z",
"orgId": "convexity",
"count": 1,
"activeCount": 1,
"workloadAllowance": 3
}
}