トークン使用量照会(Token Usage)¶
機能説明
認証を通じて、現在の Bearer Token のクォータ使用状況(付与総量、使用済み、残量、無制限かどうか、モデル制限、および有効期限)を照会します。
📮 エンドポイント¶
- リクエストヘッダーに認証情報を含める必要があります
- 現在のリクエストで使用されているトークンの使用量情報のみを返します
🔐 認証¶
APIキー認証のために、リクエストヘッダーに以下の内容を含めます:
sk-
プレフィックスの有無にかかわらずサポートされており、サーバー側で自動的に互換性が確保されます- Authorizationヘッダーがない、または無効な場合は 401 が返されます
💡 リクエスト例¶
✅ 成功レスポンス例¶
{
"code": true,
"message": "ok",
"data": {
"object": "token_usage",
"name": "Default Token",
"total_granted": 1000000,
"total_used": 12345,
"total_available": 987655,
"unlimited_quota": false,
"model_limits": {
"gpt-4o-mini": true
},
"model_limits_enabled": false,
"expires_at": 0
}
}
❗ エラーレスポンス例¶
- 認証ヘッダーの欠如:
- Bearerスキーム以外:
- トークン検索失敗(例:無効または削除済み):
🧾 フィールドの説明(data)¶
object
: 固定値token_usage
name
: トークン名total_granted
: 付与総量(= 使用済み + 残量)total_used
: 使用済みクォータtotal_available
: 利用可能な残りのクォータunlimited_quota
: 無制限クォータであるかどうかmodel_limits
: 使用が許可されているモデルのリストmodel_limits_enabled
: モデル制限が有効になっているかどうかexpires_at
: 有効期限の Unix タイムスタンプ(秒)。期限切れがない場合は0
を返します(バックエンドによって-1
が0
に正規化されます)
参考実装:
GET /api/usage/token
は PR #1161 で追加されました