API キーの残高を取得 | ToAPIs Documentation

GET

/api/v1/api-keys/{api_key_id}/balance

中国本土のユーザー向け: 中国本土のユーザーは https://api.toapis.cn を API エンドポイント (Base URL)としてご利用ください. 本ドキュメント内の例では https://api.toapis.com を https://api.toapis.cn に置き換えてください.

動作

指定キーの残クォータのスナップショットを読み取り, あとどれだけ使えるかを確認できます. 無効化・期限切れ・枯渇・ソフト削除済みのキーも読み取れます. 他人のキーまたは存在しないキーは 404 です.

返すのはデータベースに保存された残高スナップショットで, リアルタイム計算の値ではありません: 無制限キーの残額は null, 使用額は通常どおり返ります. 日/月上限のリアルタイム使用カウンタは本エンドポイントでは読み取りません. 呼び出し課金はバッチでデータベースへ書き込まれるため, バッチ反映前は実際の使用量よりわずかに古い値を読むことがあります.

認証

Authorizationstringヘッダー必須

Bearer YOUR_SYSTEM_ACCESS_TOKEN を使用します. モデルキーは不可, X-User-Id は不要です. 共通ルールは利用方法を参照してください.

リクエストパラメータ

api_key_idstringパス必須

自分の通常モデルキーの十進 ID 文字列. sk- シークレットではありません.

本文とクエリパラメータは受け付けません.

リクエスト例

curl --request GET \
  --url 'https://api.toapis.com/api/v1/api-keys/43/balance' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://api.toapis.com/api/v1/api-keys/43/balance",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.toapis.com/api/v1/api-keys/43/balance", {
  method: "GET",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

レスポンスフィールド

例は架空のデータです. メタデータはキー詳細, 共通のレスポンスとエラーは利用方法を参照してください.

data.api_key_idstring

キー ID.

data.statusstring

現在の状態, deleted を含む.

data.unlimitedboolean

クォータが無制限かどうか.

data.remaining_creditsstring | null

残り credits, 無制限は null.

data.remaining_usdstring | null

残額の USD 換算値, 無制限は null.

data.used_creditsstring

累計使用済み credits.

data.used_usdstring

累計使用額の USD 換算値.

data.daily_limit_creditsstring | null

日次 credits 上限, 無制限は null.

data.monthly_limit_creditsstring | null

月次 credits 上限, 無制限は null.

data.credits_per_usdstring

1 USD あたりの credits.

レスポンス例

{
  "code": 0,
  "message": "",
  "data": {
    "api_key_id": "43",
    "status": "enabled",
    "unlimited": false,
    "remaining_credits": "500",
    "remaining_usd": "5",
    "used_credits": "100",
    "used_usd": "1",
    "daily_limit_credits": null,
    "monthly_limit_credits": null,
    "credits_per_usd": "100"
  }
}