Skip to main content
GET
  • すべての API Key のリクエスト単位の Token 消費量と費用を照会。単一 Key での絞り込みも可能
  • 入力・出力・キャッシュヒットの Token を個別に集計
  • サマリーエンドポイントで Key ごとの合計を取得
  • カーソルベースのページネーション。期間は最長 31 日
これらのエンドポイントは課金ログを読み取り、課金対象の各リクエストの Token 内訳と費用、および Key ごとの集計を返します。単一 Key の合計残高しか返さない トークン残高の照会 を補完するものです。

認証

string
必須
このエンドポイントは sk- API Key ではなくユーザーアカウントとして認証します。
  1. アカウント設定ページ を開き、「システムアクセストークン」カードで 生成 をクリックしてアクセストークンを発行します(sk- キーではありません)。再生成すると以前のトークンは無効になります。
  2. アクセストークンとユーザー ID を一緒に送信します:
数値のユーザー ID は同じ設定ページに表示されます。
string
必須
数値のユーザー ID。アクセストークンと併せて必須です。

エンドポイント

クエリパラメータ

両エンドポイントで同一のパラメータを受け付けます。未定義または重複したパラメータは 422 で拒否されます。
integer
必須
期間の開始。Unix 秒タイムスタンプ(その時刻を含む)。
integer
必須
期間の終了。Unix 秒タイムスタンプ(その時刻を含まない)。start_timestamp より後である必要があり、期間は最長 31 日です。
integer
任意。数値のトークン ID で単一の API Key に絞り込みます。省略時はすべての Key が対象です。
integer
デフォルト:"50"
1 ページあたりの行数。1–100。
string
前回のレスポンスの meta.next_cursor に返されたページネーションカーソル。発行元と同じエンドポイント・期間・token_id フィルターでのみ有効です。

レスポンス

GET /api/usage/tokens/requests は課金対象リクエストごとに 1 行を、新しい順に返します。
integer
リクエストに対応する内部ログ ID。レスポンス内で一意です。
integer
リクエストが課金された時刻。Unix 秒タイムスタンプ。
integer
リクエストを行った API Key の ID。
string
API Key の名前。
string
リクエストを処理したモデル。
string
非同期リクエスト(画像/動画生成)のタスク ID。同期リクエストでは空。
integer
課金された入力 Token 数。
integer
課金された出力 Token 数。
integer | null
キャッシュから読み取られた入力 Token 数(キャッシュヒット)。上流が報告しない場合は null。
integer | null
キャッシュに書き込まれた Token 数。報告されない場合は null。
integer | null
上流プロバイダーが報告した合計 Token 数(利用可能な場合)。
integer
prompt_tokens + completion_tokens。
string
pre_consumed、settled、または詳細な課金メタデータが存在しない古いログでは unknown。
integer
消費されたクォータ(プラットフォーム内部単位)。
string
米ドル換算の費用。quota / quota_per_usd で計算(meta 参照)。精度保持のため文字列で返します。
GET /api/usage/tokens/summary は API Key ごとに 1 行を、token_id 昇順で返します。
integer
API Key ID。
integer
期間内の課金リクエスト数。
integer
この Key の入力 Token 合計。
integer
この Key の出力 Token 合計。
integer
prompt_tokens + completion_tokens。
integer
この Key が消費したクォータ合計。
string
この Key の米ドル費用合計。

Meta

boolean
次のページが存在するかどうか。
string
cursor として渡すと次ページを取得。has_more が false の場合は空。
string
cost_usd 換算に使用した 1 米ドルあたりの内部クォータ単位数。
boolean
消費ログが有効かどうか。false の場合、レスポンスが空になることがあります。
boolean
現時点では常に false。返金分は差し引かれません。

注意事項

  • 課金対象のリクエストのみが一覧に含まれます。課金されなかった失敗リクエストは表示されず、リクエスト単位の成功フラグも返されません。
  • 費用は課金時に記録されたクォータに基づき、現在のカタログ価格で再計算されません。返金も差し引かれません。
  • これらのエンドポイントは生の API Key、チャネル、IP アドレス、リクエスト/レスポンス内容を公開しません。
  • cursor はエンドポイント・期間・token_id フィルターに紐付いています。異なるクエリ間で再利用しないでください。
  • クエリには短いタイムアウトがあります。query_timeout を受け取った場合は期間を短くして再試行してください。