GET /usage

Koosta aruanne WorkOS-i organisatsiooni hinnangulisest tõlketokenite kasutusest (keelte kaupa) ja tabelipõhisest andmebaasi baitide kasutusest.

Autentimine: Bearer JWT (WorkOS).

Päringu parameetrid

Vastus

{
  "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": "..."
  }
}

Tokenite arvud on hinnangulised (ligikaudu 4 märki tokeni kohta heuristika ning lisaks iga kutse kohta fikseeritud süsteemiproompti maht), mitte teenusepakkuja arveldatav kasutus. Andmebaasi kasutus summeerib pg_column_size iga hallatava tabeli kohta; objektisalvestisse talletatud pildibinaare ei arvestata. Pane tähele serde iseärasust: byLanguage sees on tokenite võtmed snake_case'i kujul (estimated_prompt_tokens jne), samal ajal kui ülemobjekt kasutab camelCase'i.

Näide

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

Veateated

• 400 — puuduv või vigane orgId
• 401 — puuduv või vigane JWT
• 500 — päringu tõrge