GET /usage

Informe o uso estimado de tokens de tradução (por idioma) de uma organização WorkOS e o uso de bytes do banco de dados por tabela.

Autenticação: JWT Bearer (WorkOS).

Parâmetros de consulta

Resposta

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

As contagens de tokens são estimativas (uma heurística de ~4 caracteres por token mais uma reserva fixa por chamada para o prompt do sistema), não o uso faturado pelo provedor. O uso do banco de dados soma pg_column_size por tabela própria; binários de imagem armazenados em armazenamento de objetos não são contabilizados. Observe a peculiaridade do serde: dentro de byLanguage as chaves de tokens estão em snake_case (estimated_prompt_tokens, etc.) enquanto o objeto pai usa camelCase.

Exemplo

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

Erros

• 400 — orgId ausente ou inválido
• 401 — JWT ausente ou inválido
• 500 — falha da consulta