Balance API
查看您還有多少積分可以使用,以及其中有多少會在下一次月度刷新時過期。
GET/openapi/v1/balance
取得餘額
回傳擁有該 API 金鑰的帳戶的積分餘額。對於擁有共享積分池的團隊,回傳的值即為該池的數值。呼叫此 endpoint 不收費。
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 workspace 積分限額適用於您時,該值可能更低。團隊所有者和管理員不受此類限制。
- Name
- monthly_credits
- Type
- integer
- Description
剩餘的、會在下一次月度刷新(即
monthly_resets_at)時過期的積分數量。
- Name
- permanent_credits
- Type
- integer
- Description
不會過期的積分數量,例如來自您購買的積分包以及獎勵的積分。
- Name
- monthly_resets_at
- Type
- timestamp
- Description
下一次月度積分刷新的時間,以 Unix 毫秒表示。到達該時間時,剩餘的月度積分將過期,若有有效的 subscription 則會重新儲值。當沒有計畫中的刷新時為
null。
失敗情形
- Name
401 - Unauthorized- Description
API 金鑰缺失或無效。請檢查
Authorization請求標頭。
- Name
429 - Too Many Requests- Description
您發送的請求過多。請等待
Retry-After中指定的秒數後重試。