GET /usage

組織の推定翻訳トークン使用量とテーブルごとのデータベースバイト使用量を報告します。

WorkOS 組織の推定翻訳トークン使用量（言語別）とテーブルごとのデータベースバイト使用量を報告します。

認証: Bearer JWT（WorkOS）。

クエリパラメータ

パラメータ	型	必須	備考
`orgId`	uuid	はい	レポート対象の WorkOS 組織。

レスポンス

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

トークン数は推定値（1 トークンあたり約 4 文字というヒューリスティックに、呼び出しごとの固定システムプロンプト許容量を加えたもの）であり、プロバイダーの課金対象となる使用量ではありません。データベース使用量は、所有する各テーブルについて pg_column_size を合計した値です。オブジェクトストレージに保存された画像バイナリは計上されません。byLanguage 内のトークンキーがスネークケース（estimated_prompt_tokens など）で、親オブジェクトはキャメルケースを使用しているという serde の癖に注意してください。

例

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

エラー

400 — orgId が欠落しているか無効
401 — JWT が欠落しているか無効
500 — クエリ失敗

Previous‹PATCH /translations NextCSV 投稿›

パラメータ

型

必須

備考

orgId

uuid

はい

レポート対象の WorkOS 組織。

レスポンス

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