GET /usage

Genera un informe del uso de tokens de traducción estimado (por idioma) de una organización de WorkOS y del uso de bytes de la base de datos por tabla.

Autenticación: JWT Bearer (WorkOS).

Parámetros de consulta

Respuesta

{
  "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": "documentos", "rows": 42, "bytes": 500000 } ],
    "note": "..."
  }
}

Los recuentos de tokens son estimaciones (una heurística de ~4 caracteres por token más una asignación fija por llamada para el prompt del sistema), no el uso facturado por el proveedor. El uso de la base de datos suma pg_column_size por cada tabla propia; los binarios de imágenes almacenados en un almacenamiento de objetos no se contabilizan. Ten en cuenta la peculiaridad de serde: dentro de byLanguage las claves de tokens están en snake_case (estimated_prompt_tokens, etc.) mientras que el objeto padre usa camelCase.

Ejemplo

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

Errores

• 400 — orgId faltante o inválido
• 401 — JWT faltante o inválido
• 500 — error en la consulta