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

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}
現在のユーザーアカウントの残高と使用済み残高を取得します。このエンドポイントは特定のトークンに依存しないユーザーレベルの残高情報を返し、アカウント全体の残高を確認するために使用されます。 
curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}

​
認証

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

​
エンドポイント

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

​
レスポンス

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

​
トークン残高 vs ユーザー残高

比較項目トークン残高 (/v1/balance)ユーザー残高 (/v1/user/balance)
スコープ単一トークンユーザーアカウント全体
データソースTokenのRemainQuotaとUsedQuotaUserのquotaとused_quota
ユースケース単一APIキーの使用状況を監視アカウント全体の残高を表示
制限トークンレベルの制限ユーザーレベルの制限

​
ユースケース

  • ユーザーアカウント全体の残高を確認
  • チャージリマインダーと残高アラートを設定
  • ユーザーダッシュボードでアカウント残高を表示
残高単位について残高の単位はシステム設定によって異なります：
  • USD - 米ドル
  • CNY - 人民元
  • Tokens - トークン数
無制限ユーザーユーザーが無制限に設定されている場合：
  • unlimited_quota フィールドは true を返します
  • remain_balance フィールドは -1 を返します
  • そのユーザーは制限なしでAPIを無制限に使用できます

​
一般的なエラー

エラーメッセージ原因解決策
AuthorizationヘッダーなしAuthorizationヘッダーが提供されていないAuthorization: Bearer sk-xxxxxヘッダーを追加
ユーザー残高の取得に失敗ユーザーが存在しないトークンに関連付けられたユーザーが存在するか確認
使用済み残高の取得に失敗データベースクエリエラー管理者に連絡してシステム状態を確認
セキュリティに関する注意APIキーはパスワードと同様です。安全に保管し、他人と共有しないでください。本番環境では必ずHTTPSを使用してください。