Get started

Organisation workloads

Source

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.

text
GET /api/v1/org/workloads
POST /api/v1/org/workloads
GET /api/v1/org/workloads/{slug}
POST /api/v1/org/workloads/{slug}
text
Authorization: Bearer vitna_push_...
bash
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:

  • active workloads count against the organisation's metered allowance (1 on Free, 3 on Deploy, unmetered under an operator agreement).
  • paused workloads stop counting toward the active allowance while retaining all standing decisions, lane rules and measurements. Resuming (paused to active) checks the active allowance inside the write transaction and answers 402 plan_allowance_exceeded if all slots are full.
  • archived workloads permanently retire a lane while keeping its audit trail intact (409 workload_archived if asked to re-activate).

Response shape

json
{
  "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
  }
}