本文へスキップ

残高とクォータを照会

このキーで現時点でいくら使えるか、およびそのクォータを照会します。課金されず、残高がプラスである必要もありません。

GET/v1/usage

balance はこのキーで現時点で使える額です。キーにクォータを設定していなければアカウント残高、設定していればキーの残りクォータになります。チームメンバーや部門のキーは、さらに当期の残りクォータで上限がかかります。クォータを設定したキーもアカウント残高から差し引かれるため、アカウント残高が先に尽きると、balance に余裕があってもリクエストは 402 を返します。

金額は米ドル建てです(2026-10-01 以降 ledger_currency は "USD" で、unit と一致します):balance、remaining、サフィックスのない quota.* はすべて米ドルの金額です。人民元額が必要な場合は _cny フィールドを読んでください(_usd と同じ金額の人民元額。固定の換算で、リアルタイムの為替レートではありません)。このエンドポイントは Authorization: Bearer のみを受け付け、標準のエラー構造を使いません。HTTP ステータスコードだけでなく is_active で判定してください。

非同期タスクの照会では、タスク終了後にルートオブジェクトの usage にタスク単位の課金額(米ドル額 cost_usd、人民元額 cost、cost の通貨 currency)が含まれます。タスク一覧でも終了済みの各タスクの usage に同じ項目が入ります(上記の _cny / _usd フィールドは本エンドポイント専用です)。課金額を参照してください。

ヘッダー

Authorization:必須string

Bearer sk-…:コンソールの「API キー」で作成したキー。キーのグループにリクエストするモデルが含まれている必要があります

レスポンス

200残高とクォータ。キーの期限切れやメンバーの無効化時も 200 で、is_active: false になります

is_active:任意boolean

balance が 0 より大きい場合に true

balance:任意number

このキーで現時点で使える額(米ドル)

remaining:任意number

balance と同じ

unit:任意string

常に "USD"。ledger_currency と一致します

ledger_currency:任意string

サフィックスのない金額の通貨。"USD"(2026-10-01 より前は "CNY")

balance_cny:任意number

balance の人民元金額

balance_usd:任意number

balance の米ドル金額

quota:任意object

キーのクォータ

message:任意string

異常時のみ:api key expired、member disabled など

group:任意object

このキーが属するグループ。専用グループでは返されません

エラー

401キー未指定、または sk- で始まらない:missing or invalid api key。キーが存在しない、または無効化済み:invalid api key

関連ページ