モデル別の使用量を照会する
GET /api/open/v1/usage/modelsリクエストパラメーター
Section titled “リクエストパラメーター”| パラメーター | 位置 | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|---|
start_timestamp | query | integer | いいえ | 下記参照 | 開始時刻(含む)、unix 秒 |
end_timestamp | query | integer | いいえ | 下記参照 | 終了時刻(含む)、unix 秒 |
limit | query | integer | いいえ | 10 | 返すモデル数。1〜100 の整数。範囲外は 400 を返します |
時間範囲のルール:
- 両方とも省略: 直近 30 日間。
start_timestampのみ指定: そこから 30 日後まで。ただし現在時刻を超えません。end_timestampのみ指定: そこから 30 日前まで。- 範囲は最大 366 日です。
リクエスト例
Section titled “リクエスト例”curl "https://www.routeapi.ai/api/open/v1/usage/models?start_timestamp=1726400000&end_timestamp=1729000000&limit=10" \ -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"レスポンス例
Section titled “レスポンス例”{ "success": true, "message": "", "data": { "items": [ { "model_name": "gpt-4o", "prompt_tokens": 120000, "completion_tokens": 30000, "total_tokens": 150000, "amount": 3.20 } ], "start_timestamp": 1726400000, "end_timestamp": 1729000000 }}レスポンスフィールド
Section titled “レスポンスフィールド”| フィールド | 型 | 説明 |
|---|---|---|
items[].model_name | string | モデル名 |
items[].prompt_tokens | integer | このモデルの時間範囲内の入力トークン総数 |
items[].completion_tokens | integer | このモデルの時間範囲内の出力トークン総数 |
items[].total_tokens | integer | 入力と出力のトークン合計 |
items[].amount | number | このモデルで消費した金額。サイトの表示通貨、小数点以下 2 桁 |
start_timestamp | integer | 実際に適用された開始時刻 |
end_timestamp | integer | 実際に適用された終了時刻 |
| HTTP | code | シナリオ |
|---|---|---|
| 400 | invalid_request | limit が 1〜100 の整数ではない、タイムスタンプが負の値、または時間範囲が不正 |
| 429 | — | ユーザーごとの照会レート制限(デフォルト 30 回/分)を超過。レスポンスボディが空の場合があります |
その他の共通エラーコードは プラットフォーム API のエラー を参照してください。
- 結果は
total_tokensの降順で並びます。使用量が同じ場合はモデル名の昇順で並び、順序は安定します。 - 消費(課金)ログのみを集計し、失敗したリクエストは含まれません。
- トークン数は実数で、百万単位ではありません。
- 金額はサイトの表示通貨で表されます。残高を照会する を参照してください。
- 各行の
amountは個別に四捨五入されるため、各行の合計と全体の金額が ±0.01 ずれる場合があります。 - このエンドポイントは 使用量統計、アカウントログ、ログのエクスポート、Key 別使用量 とユーザーごとの照会レート制限(デフォルト 30 回/分)を共有します。レート制限 を参照してください。