Skip to main content
GET
現在のAPIキー(トークン)の残高と使用済み残高を取得します。このエンドポイントは単一トークンの使用状況を監視するために使用されます。

認証

string
必須
すべてのAPIエンドポイントにはBearer Token認証が必要ですAPIキーの取得:APIキー管理ページにアクセスしてAPIキーを取得してくださいリクエストヘッダーに追加:

エンドポイント

両方のエンドポイントは同じ機能を持っています。どちらでも使用できます。

レスポンス

boolean
リクエストが成功したかどうか
string
エラーメッセージ(失敗時のみ返却)
float
トークン残高(成功時に返却)。unlimited_quotatrue の場合、値は -1 になります
integer
トークン残りクレジット(成功時に返却)。unlimited_quotatrue の場合、値は -1 になります
float
トークン使用済み残高(成功時に返却)
integer
トークン使用済みクレジット(成功時に返却)
boolean
トークンが無制限かどうか。true は無制限、false は制限ありを意味します

ユースケース

  • 単一APIキーの消費状況を監視
  • アプリケーションで現在のトークン残高を表示
  • 残高がしきい値を下回った時にアラートを設定
残高単位について残高の単位はシステム設定によって異なります:
  • USD - 米ドル
  • Credits - クレジット
無制限トークントークンが無制限に設定されている場合:
  • unlimited_quota フィールドは true を返します
  • remain_balance フィールドは -1 を返します
  • remain_credits フィールドは -1 を返します
  • そのトークンは制限なしで無制限に使用できます

一般的なエラー

セキュリティに関する注意APIキーはパスワードと同様です。安全に保管し、他人と共有しないでください。本番環境では必ずHTTPSを使用してください。