Skip to main content
GET
Read credit balance / 查询积分余额
API preview: generation providers are not connected. An authenticated request can return 503 without creating a task or charging credits.

Purchased, reserved, available

Payment orders record USD and the number of credits issued. Model consumption is recorded in Credits. Purchased credits are not API usage. Your available balance is the ledger balance minus outstanding reservations. Pricing shown during preview is illustrative. The production exchange rate, payment channel, and active channel prices must be published before paid execution is enabled. View pricing Open billing

Read your balance

GET /v1/balance requires usage:read. It returns balance_credits, reserved_credits, and available_credits. A new account may correctly return zero. The endpoint never creates trial credits or runs a payment.

Four results, one clear total

Example only. Failed attempts are platform costs; they are not added to the user’s bill. Each result item has at most one final consumption entry.

Prices are locked at acceptance

  • Each channel has its own parameter-based price, including rounding, minimum units, and applicable surcharges.
  • Official success uses the disclosed official rate; low-cost success uses the low-cost rate. A later price edit cannot increase an accepted request’s cap.
  • Unknown items retain only their own reservation. Known successful and failed siblings can settle or release independently.
  • LLM stream interruption and native music bundles use their own published metering rules, not the image/video rule by assumption.

Authorizations

Authorization
string
header
required

API key beginning as_. Keep on the server. Scope permissions are checked separately.

Response

Account credit balance

balance_credits
number
required

Credits, not USD. / 积分,非美元。

Required range: x >= 0
reserved_credits
number
required

Credits, not USD. / 积分,非美元。

Required range: x >= 0
available_credits
number
required

Credits, not USD. / 积分,非美元。

Required range: x >= 0