API Key の使用量を取得

ユーザー API Key ごとの使用量明細をページネーション付きで返します。

概要

この endpoint は、非公開のプロバイダー詳細を公開せずに、API Key 単位の使用量明細を返します。

クエリパラメータ

パラメータ	型	既定値 / 制約	説明
`page`	integer	既定値 `1`、最小 `1`	1 始まりのページ番号
`limit`	integer	既定値 `50`、最小 `1`、最大 `100`	1 ページあたりの件数
`model`	string	最大長 `100`	リクエスト時に指定されたモデル名
`modelVendor`	string	最大長 `100`	公開モデルのベンダー名
`scene`	enum	-	`chat`, `image`, `audio`, `video`, `embedding`, `rerank`, `translation`, `music`, `3d`, `realtime`
`startDate`	string	-	開始日時（含む）。タイムゾーン付き RFC3339 または `YYYY-MM-DD` を受け付けます
`endDate`	string	-	終了日時（含む）。タイムゾーン付き RFC3339 または `YYYY-MM-DD` を受け付けます

startDate と endDate を同時に指定する場合、startDate は endDate 以下である必要があります。

補足

金額フィールドは USD のみをサポートします。
レスポンスはページネーションされます。
レスポンスには公開可能な Billing / Reporting 項目のみが含まれます。
基になるリクエストの課金精算が完了すると、各 usage 明細に billing_transaction_id が含まれる場合があります。request_id と合わせてリクエスト単位の照合に使用してください。
非公開のプロバイダー詳細は非表示のままです。

例

リクエスト

cURL

curl "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456/usage?page=1&limit=20&scene=chat&startDate=2026-07-01&endDate=2026-07-31" \
  -H "Authorization: Bearer mt-your-management-token"

リクエスト / レスポンス

このページでは OpenAPI スキーマとコピー可能なリクエスト例を提供します。管理リクエストは、Management Token を使ってターミナルまたはクライアントから送信してください。このページから直接送信することはできません。

レスポンス例

レスポンス

200 OK

{
  "api_key": {
    "id": "key_abc123def456",
    "name": "Backend Worker",
    "key_prefix": "sk-live...",
    "status": "active",
    "limit_amount": 500,
    "limit_amount_decimal": "500",
    "used_amount": 148.25,
    "used_amount_decimal": "148.25",
    "models": [
      "gpt-5.6-luna",
      "claude-3-7-sonnet"
    ],
    "expires_at": "2026-12-31T23:59:59.000Z",
    "last_used_at": "2026-07-08T03:12:45.000Z",
    "created_at": "2026-07-01T10:00:00.000Z",
    "delivery_policy": null
  },
  "items": [
    {
      "request_id": "req_abc123",
      "billing_transaction_id": "billtxn_abc123",
      "model": "gpt-5.6-luna",
      "logical_model": "gpt-5.6-luna",
      "model_vendor": "OpenAI",
      "scene": "chat",
      "usage_unit": "per_token",
      "usage_quantity": 1500,
      "usage_quantity_decimal": "1500",
      "prompt_tokens": 1000,
      "completion_tokens": 500,
      "total_tokens": 1500,
      "cache_read_tokens": 0,
      "cache_write_tokens": 0,
      "cache_write_tokens_5m": 0,
      "cache_write_tokens_1h": 0,
      "cost": 0.0012,
      "cost_decimal": "0.0012",
      "created_at": "2026-07-08T03:15:00.000Z",
      "requested_policy": null,
      "resolved_tier": null,
      "charged_price_basis": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  },
  "summary": {
    "total_requests": 1,
    "total_cost": 0.0012,
    "total_cost_decimal": "0.0012",
    "total_prompt_tokens": 1000,
    "total_completion_tokens": 500,
    "total_tokens": 1500,
    "usage_unit_breakdown": [
      {
        "usage_unit": "per_token",
        "usage_quantity": 1500
      }
    ]
  },
  "breakdowns": {
    "by_model": [
      {
        "model": "gpt-5.6-luna",
        "logical_model": "gpt-5.6-luna",
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012",
        "usage_quantity": 1500,
        "usage_quantity_decimal": "1500"
      }
    ],
    "by_logical_model": [
      {
        "model": "gpt-5.6-luna",
        "logical_model": "gpt-5.6-luna",
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012",
        "usage_quantity": 1500,
        "usage_quantity_decimal": "1500"
      }
    ],
    "by_model_vendor": [
      {
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012
      }
    ],
    "by_scene": [
      {
        "scene": "chat",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012"
      }
    ],
    "daily_cost": [
      {
        "date": "2026-07-08T00:00:00.000Z",
        "cost": 0.0012,
        "cost_decimal": "0.0012"
      }
    ]
  }
}

重要なフィールド

api_keyobject

list/create/update レスポンスと同じフィールドを持つ API キー概要。

itemsarray

ページネーションされた利用明細。

paginationobject

page、limit、total、totalPages を含むページネーションメタデータ。

summaryobject

選択したフィルターに基づく集計値。

breakdownsobject

選択したフィルターに基づく内訳。

items[].request_idstring | null

サポートと照合に使用する公開リクエスト識別子。

items[].billing_transaction_idstring | null

利用可能な場合の決済済み請求トランザクション ID。

items[].modelstring

リクエストされた公開モデル名。

items[].logical_modelstring

レポートに使用する論理公開モデル。

items[].model_vendorstring | null

公開モデルベンダー。

items[].scenestring | null

公開リクエストシーン。

items[].usage_unitstring

per_token などの請求単位。

items[].usage_quantitynumber

表示用に JSON 数値で返される使用量。

items[].usage_quantity_decimalstring

10 進文字列で返される正確な使用量。

items[].prompt_tokensnumber

プロンプトトークン数。

items[].completion_tokensnumber

完了トークン数。

items[].total_tokensnumber

総トークン数。

items[].cache_read_tokensnumber

キャッシュ読み取りトークン数。

items[].cache_write_tokensnumber

キャッシュ書き込みトークン総数。

items[].cache_write_tokens_5mnumber

5 分キャッシュ書き込みトークン数。

items[].cache_write_tokens_1hnumber

1 時間キャッシュ書き込みトークン数。

items[].costnumber

表示用に JSON 数値で返される USD コスト。

items[].cost_decimalstring

10 進文字列で返される正確な USD コスト。

items[].requested_policystring | null

auto, verified, official, null. 記録されたリクエストの配信ポリシー。

items[].resolved_tierstring | null

verified, official, null. 記録された実際の配信区分。

items[].charged_price_basisobject | null

記録された適用価格と課金対象の使用量。

items[].created_atstring

利用明細の ISO タイムスタンプ。

summary.total_requestsnumber

総リクエスト数。

summary.total_costnumber

表示用に JSON 数値で返される USD の総コスト。

summary.total_cost_decimalstring

10 進文字列で返される USD の正確な総コスト。

summary.total_prompt_tokensnumber

プロンプトトークン総数。

summary.total_completion_tokensnumber

完了トークン総数。

summary.total_tokensnumber

総トークン数。

summary.usage_unit_breakdownarray

利用単位別にグループ化した使用量。

breakdowns.by_modelarray

リクエストされた公開モデル別の内訳。

breakdowns.by_logical_modelarray

論理公開モデル別の内訳。

breakdowns.by_model_vendorarray

公開モデルベンダー別の内訳。

breakdowns.by_scenearray

公開リクエストシーン別の内訳。

breakdowns.daily_costarray

日次コスト推移。

認証

ManagementTokenAuth

AuthorizationBearer <token>

管理トークン認証。Dashboard > API > Management Tokensで管理トークンを作成または管理します。

場所: header

パスパラメータ

keyId*string

クエリパラメータ

page?integer

1から始まるページ番号。デフォルトは1です。

範囲1 <= value

デフォルト1

limit?integer

ページサイズ。デフォルトは50、最大は100です。

範囲1 <= value <= 100

デフォルト50

model?string

リクエストされたモデル名によるフィルタリング。最大長100。

長さlength <= 100

modelVendor?string

公開モデルベンダーによるフィルタリング。最大長100。

長さlength <= 100

scene?string

公開リクエストシーンによるフィルタリング。

指定できる値

"chat"
"image"
"audio"
"video"
"embedding"
"rerank"
"translation"
"music"
"3d"
"realtime"
"systemone"

startDate?string

包括的な日付フィルタ。タイムゾーン付きのRFC3339（例: 2026-03-28T00:00:00+08:00）またはYYYY-MM-DDを受け付けます。

endDate?string

包括的な日付フィルタ。タイムゾーン付きのRFC3339（例: 2026-03-28T00:00:00+08:00）またはYYYY-MM-DDを受け付けます。

API Key の使用量を取得

概要

クエリパラメータ

補足

例

リクエスト / レスポンス

レスポンス例

重要なフィールド

認証

パスパラメータ

クエリパラメータ

レスポンス

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

API Key の使用量を取得

概要Copy Anchor Link

クエリパラメータCopy Anchor Link

補足Copy Anchor Link

例Copy Anchor Link

リクエスト / レスポンスCopy Anchor Link

レスポンス例Copy Anchor Link

重要なフィールドCopy Anchor Link

認証Copy Anchor Link

パスパラメータCopy Anchor Link

クエリパラメータCopy Anchor Link

レスポンスCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

概要

クエリパラメータ

補足

例

リクエスト / レスポンス

レスポンス例

重要なフィールド

認証

パスパラメータ

クエリパラメータ

レスポンス

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`