Skip to main content
GET
/
v1
/
balance
Get credit balance
curl --request GET \
  --url https://api.example.com/v1/balance \
  --header 'X-Api-Key: <api-key>'
{
  "credits": 1023.49,
  "held_credits": 4,
  "available_credits": 1019.49,
  "currency": "credit"
}

Documentation Index

Fetch the complete documentation index at: https://docs.aurous-labs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Api-Key
string
header
required

Your team API key (starts with al_live_ — legacy keys may start with og_).

Headers

Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-05-15 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-15"

Response

Current credit balance trio

credits
number
required

Total credits on the team (sum of available + held).

Example:

1023.49

held_credits
number
required

Credits currently held against pending generations (D6: charge-on-success). Released back to the available balance when the generation fails, is cancelled, expires, or is moderation_rejected.

Example:

4

available_credits
number
required

Spendable balance — credits − held_credits. New POST /v1/images checks against this value and returns 402 invalid_request / balance_too_low if insufficient.

Example:

1019.49

currency
enum<string>
required

Currency identifier; always "credit" today. Reserved for future fiat reporting.

Available options:
credit
Example:

"credit"