跳转到主要内容
GET
Get credit balance
查询不消耗积分,因此程序可以在每次提交批次前检查。remaining 已扣除排队中和运行中任务冻结的积分。各字段的含义见积分与限制。

授权

Authorization
string
header
必填

Your API key, sent as Authorization: Bearer <key>.

响应

Your account's credits.

success
boolean
必填
remaining
number
必填

Credits you can spend now, with up to two decimals. Tasks you already submitted hold their price in reserved, so it is not in this number. A submit that needs more returns 402 INSUFFICIENT_CREDITS.

perCycle
number | null
必填

Credits your plan grants each billing cycle. null without an active plan.

cycleResetsAt
string<date-time> | null
必填

When the current billing cycle ends. At renewal your balance becomes the next cycle's plan credits plus the top-up credits you still hold. null without an active plan.

reserved
number
必填

Credits your queued and running tasks hold. A completed task is charged from its hold, and a failed task's hold returns to remaining.

plan
enum<string>
必填

Your plan. free when no paid plan is active.

可用选项:
free,
basic,
pro,
scale,
max
topUpBalance
object | null
必填

Top-up credits within remaining. They last three months from purchase, carry over renewals, and are spent after your plan's credits. null when you have none.