GET /usage

Rapporteer het geschatte gebruik van vertalingstokens (per taal) van een WorkOS-organisatie en het datagebruik in bytes per tabel.

Auth: Bearer JWT (WorkOS).

Queryparameters

Antwoord

{
  "orgId": "...",
  "translations": {
    "translations": 120,
    "estimatedPromptTokens": 45000,
    "estimatedCompletionTokens": 42000,
    "estimatedTotalTokens": 87000,
    "byLanguage": [
      {
        "language": "fr",
        "translations": 40,
        "estimated_prompt_tokens": 15000,
        "estimated_completion_tokens": 14000,
        "estimated_total_tokens": 29000
      }
    ],
    "note": "..."
  },
  "database": {
    "totalBytes": 1048576,
    "totalHuman": "1.0 MB",
    "byTable": [ { "table": "documents", "rows": 42, "bytes": 500000 } ],
    "note": "..."
  }
}

Tokenaantallen zijn schattingen (een heuristiek van ~4 tekens per token plus een vaste systeemprompt-toelage per call), niet het in rekening gebrachte gebruik van de provider. Databasegebruik telt pg_column_size per eigen tabel bij elkaar op; afbeeldingsbinaire bestanden die in objectopslag worden bewaard, worden niet meegeteld. Let op de serde-eigenaardigheid: binnen byLanguage zijn de tokensleutels snake_case (estimated_prompt_tokens, enz.) terwijl het bovenliggende object camelCase gebruikt.

Voorbeeld

curl '{CMS_API_URL}/usage?orgId=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>'

Fouten

• 400 — ontbrekende of ongeldige orgId
• 401 — ontbrekende of ongeldige JWT
• 500 — queryfout