トークン残高照会

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
}

GET

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

必須

すべての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 は制限ありを意味します

残高単位について残高の単位はシステム設定によって異なります：

無制限トークントークンが無制限に設定されている場合：

エラーメッセージ	原因	解決策
Authorizationヘッダーなし	Authorizationヘッダーが提供されていない	`Authorization: Bearer sk-xxxxx`ヘッダーを追加
トークン情報の取得に失敗	トークンが存在しないか削除された	トークンキーが正しいか確認

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