API リファレンス

残高

GET/v1/balance

アカウント残高と、呼び出し元の API キーであといくら使えるかを USD で返します。無料かつ読み取り専用:モデル呼び出しも課金もありません。使い切ったキーや期限切れのキーでも呼び出せます。拒否されるのは無効化されたキーだけです。

#リクエストパラメーター

  • Authorizationheader必須

    Bearer sk-YOUR_KEY。ボディもクエリパラメーターもありません。

balance はアカウント全体のウォレット残高で、大きなジョブの精算後にマイナスになることがあります。available はこのキーで今使える金額で、balance とキー自身の残り上限額のうち小さいほうになり、0 を下回ることはありません。キーに独自の上限がない場合、key.remaining は null です。expires_at が 0 なら有効期限はありません。

B2B の利用者は、処理を送る前にこれをポーリングし、available が少なくなったらチームに警告できます。リクエスト署名が有効な場合は、そのキーの他の呼び出しと同じように、パス /v1/balance で署名してください。

#関連するエラー

  • 401キーがない、無効、または無効化されています — またはリクエスト署名が有効な場合に、署名がないか誤っています。
  • 403アカウントが無効化されています。
  • 500残高を読み取れませんでした。数秒後に再試行してください。

エラーコード一覧 →

#リクエスト例

curl https://www.aisplice.store/v1/balance \
  -H "Authorization: Bearer sk-YOUR_KEY"

#レスポンス

response.json
{
  "object": "balance",
  "currency": "USD",
  "balance": 12.5,
  "available": 2,
  "key": {
    "name": "app",
    "unlimited": false,
    "remaining": 2,
    "used": 1,
    "expires_at": 0
  }
}

まだ解決しませんか?

リクエスト ID かエラーメッセージを送っていただければ、こちらで調査します。