Balance API
查看您还有多少积分可以使用,以及其中有多少会在下一次月度刷新时过期。
GET/openapi/v1/balance
获取余额
返回拥有该 API key 的账户的积分余额。对于拥有共享积分池的团队,返回的值即为该池的数值。调用此 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 key 缺失或无效。请检查
Authorization请求头。
- Name
429 - Too Many Requests- Description
您发送的请求过多。请等待
Retry-After中指定的秒数后重试。