Skip to main content
GET
API Key で指定期間の消費金額を照会し、モデルで絞り込み、モデル別・暦日別または両方で集計できます。集計結果を直接返すため、タスクの作成や状態のポーリングは不要です。

認証

string
必須
モデル呼び出しと同じ API Key を Bearer Token として使用します。API Key 管理ページでキーを取得してください。
残高が 0 でも照会できます。残高は検証しませんが、API Key の状態、有効期限、IP 許可リスト、アカウント状態は検証します。

エンドポイント

両エンドポイントは同じ機能を提供し、CORS に対応します。API Key を適切に保管し、公開フロントエンドコードに露出させないでください。

リクエストパラメータ

すべてのパラメータは URL のクエリで渡します。
integer | string
開始時刻を含みます。秒単位の Unix タイムスタンプ、またはタイムゾーン付き RFC3339 文字列(例:2026-09-01T00:00:00+08:00)を使用できます。省略時は end の 24 時間前。タイムスタンプはミリ秒ではなく秒単位です。
integer | string
終了時刻を含みません。start と同じ形式を使用し、省略時は現在時刻です。start より後である必要があり、end - start は 31 日以内です。
string
モデル名。省略時は全モデルを対象とします。複数モデルは半角コンマで区切り、最大 50 個です。大文字・小文字を区別しない完全一致。ワイルドカードは非対応です。例:gpt-5.6-luna,sora-2
string
デフォルト:"none"
集計方法:
  • none:合計のみ返し、items は空配列
  • model:モデル別に集計
  • date:暦日別に集計
  • model,date:モデルと暦日の組み合わせで集計
string
デフォルト:"Asia/Shanghai"
IANA タイムゾーン名。既定値は Asia/Shanghaigroup_bydate を含む場合の暦日境界のみに影響し、照会の開始・終了時刻は変更しません。RFC3339 時刻は文字列自身のタイムゾーンで解析されます。
string
デフォルト:"key"
統計対象:
  • key:現在の API Key のみ(既定)
  • account:現在の API Key が属するアカウントの全 API Key を合算
照会期間は [start, end)(開始を含み、終了を含まない)です。前の照会の end と次の照会の start を同じ時刻にすると、境界を重複計算しません。URL を手動で組み立てる場合、RFC3339 の +%2B にエンコードしてください。例の cURL --data-urlencode、Python params、JavaScript URLSearchParams は自動で処理します。

リクエスト例

現在の API Key の直近 24 時間の消費合計

クエリパラメータを省略すると、既定の期間・対象・集計方法を使用します。

アカウント全体における指定モデルの日別消費

北京時間の 2026 年 9 月 11 日から 9 月 18 日まで(9 月 18 日を含まない)の消費を照会します。

モデルと暦日の組み合わせで集計

この集計方法では、各 items 要素に modeldate の両方が含まれます。

レスポンスフィールド

boolean
照会の成否。成功時は true、用量照会エラー時は false
object
成功時に照会範囲、合計、集計明細を返します。
data.totaldata.items[] は次の統計フィールドを共有します。
object
用量照会エラー時に返し、codemessagetype を含みます。typeusage_query_error。401 / 403 の認証エラーは認証レイヤーから返されます。

レート制限とキャッシュ

  • API Key ごとに毎分最大 60 回。グローバル API レート制限も適用
  • 同一パラメータの結果は 60 秒キャッシュ。レスポンスヘッダー X-Usage-Cachehit または miss
  • 消費記録は通常 1 秒以内に照会可能ですが、直近 1 分のデータは不完全な場合があり、キャッシュ遅延もあります
  • 照会間隔は 1 分以上を推奨。リアルタイム課金通知としては使用しないでください

統計の基準

  • 課金が成功した呼び出し記録を使用し、公式サイトのダッシュボードと同じデータです
  • 失敗呼び出し・失敗後に返金されたタスクは除外され、手動相殺は不要。画像バッチが部分成功した場合は実際に提供した枚数で課金
  • 課金の計上時刻で消費を帰属。非同期画像・動画タスクは送信時ではなく完了時に計上し、日付をまたぐタスクは完了日に属します
  • 削除後に再作成した API Key は新しい Key。新 Key の scope=key 照会に旧 Key の履歴は含まれません
  • 手動の残高調整は呼び出し消費ではなく、統計対象外
  • 2026 年 4 月 27 日より後のデータを照会可能

エラー処理

503 usage_unavailable では金額は返りません。照会できないことを意味し、消費が 0 という意味ではありません。失敗レスポンスをゼロ金額に変換したり、過去の成功結果を上書きしないでください。

他のエンドポイントとの違い

残りの利用枠は トークン残高の照会 または ユーザー残高の照会 を使用してください。