メインコンテンツへスキップ
GET
https://api.apimart.ai
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}
現在のAPIキー（トークン）の残高と使用済み残高を取得します。このエンドポイントは単一トークンの使用状況を監視するために使用されます。 
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

​
認証

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

​
エンドポイント

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

​
レスポンス

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

​
ユースケース

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

​
一般的なエラー

エラーメッセージ原因解決策
AuthorizationヘッダーなしAuthorizationヘッダーが提供されていないAuthorization: Bearer sk-xxxxxヘッダーを追加
トークン情報の取得に失敗トークンが存在しないか削除されたトークンキーが正しいか確認
セキュリティに関する注意APIキーはパスワードと同様です。安全に保管し、他人と共有しないでください。本番環境では必ずHTTPSを使用してください。