コンテンツにスキップ
無料で登録
API リファレンス

API Key の利用枠を確認する

Bearer 認証を使って、1 つの BetterToken API Key の使用済み利用枠と残りの利用枠を取得します。返された通貨と換算係数で金額に換算する方法を説明します。

GET https://bettertoken.ai/api/usage/token/ を使うと、1 つの BetterToken API Key の使用済み利用枠と残りの利用枠を取得できます。

リクエストを送信する

モデルの呼び出しに使う sk-... で始まる BetterToken API Key を使用します。次のコマンドを実行する前に、ローカル環境変数 BETTERTOKEN_API_KEY に設定してください。

認証には Authorization: Bearer <API_KEY> を使います。パラメータとリクエスト本文は不要です。URL 末尾のスラッシュを残してください。完全な URL に /v1 は含まれません。

ターミナルウィンドウ
curl -sS 'https://bettertoken.ai/api/usage/token/' \
-H "Authorization: Bearer ${BETTERTOKEN_API_KEY}"

成功時のレスポンス

code: true は照会の成功を示します。以下はレスポンスの抜粋で、数値は説明用の例です。

{
"code": true,
"message": "ok",
"data": {
"object": "token_usage",
"name": "example-key",
"total_granted": 1000000,
"total_used": 250000,
"total_available": 750000,
"unlimited_quota": false,
"quota_currency": "USD"
}
}

利用枠の読み方

フィールド意味
data.total_availableこの Key の残りの利用枠。内部の利用枠単位で返されます。
data.total_usedこの Key の累積使用済み利用枠。同じ単位です。
data.total_granted使用済み利用枠と残りの利用枠の合計。同じ単位です。
data.quota_currency利用枠の通貨。例:USD。
data.unlimited_quotatrue の場合、この Key に個別の利用枠上限はありません。ただし、ウォレット残高による支出の制限はあります。

金額に換算する

GET https://bettertoken.ai/api/status のレスポンスから data.quota_per_unit を取得します。利用枠をこの係数で割ると、data.quota_currency の通貨で金額を求められます。

残りの金額 = data.total_available / data.quota_per_unit

例えば、換算係数が 500000 なら、上の例は 750000 / 500000 = 1.50 USD です。使用済み利用枠も同じ方法で換算します。

アカウントのウォレット残高は BetterToken Workspace で確認してください。この API は、リクエストの認証に使った API Key の利用枠のみを返します。

この Key の最近のリクエストは、API Key のリクエストログで確認できます。