Balance API
利用可能なクレジット数と、そのうち次回の月次リフレッシュで失効するクレジット数を確認します。
GET/openapi/v1/balance
残高を取得する
APIキーを所有するアカウントのクレジット残高を返します。共有クレジットプールを持つチームの場合、値はそのプールのものになります。このエンドポイントの呼び出しは無料です。
Request
GET
/openapi/v1/balancecurl https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"balance": 1000,
"monthly_credits": 600,
"permanent_credits": 400,
"monthly_resets_at": 1793491200000
}
戻り値
- Name
- balance
- Type
- integer
- Description
利用可能なクレジット数です。通常は
monthly_creditsとpermanent_creditsの合計になります。メンバーのクレジット上限やEnterpriseワークスペースのクレジット上限が適用される場合は、これより低くなることがあります。チームのオーナーと管理者にはこのような上限はありません。
- Name
- monthly_credits
- Type
- integer
- Description
monthly_resets_atの次回月次リフレッシュで失効する、残りのクレジット数です。
- Name
- permanent_credits
- Type
- integer
- Description
失効しないクレジット数です。例えば、購入したクレジットパックや報酬によるものが該当します。
- Name
- monthly_resets_at
- Type
- timestamp
- Description
次回の月次クレジットリフレッシュの時刻（Unixミリ秒）です。この時刻に、残りの月次クレジットが失効し、有効なサブスクリプションがあればそれを補充します。リフレッシュが予定されていない場合は
nullになります。
失敗モード
- Name
401 - Unauthorized- Description
APIキーが欠落しているか無効です。
Authorizationヘッダーを確認してください。
- Name
429 - Too Many Requests- Description
リクエストを送信しすぎました。
Retry-Afterに示された秒数だけ待ってから再試行してください。