Skip to main content
GET
Current account balance (free)
Auth: Required · Cost: Free (no charge) · Use case: show a client their remaining grant without spending it
Read-only snapshot of the money side of your API key. Free by design — the point is to check what you have before firing a paid call, and a probe that costs money defeats that. Use this endpoint to:
  • Render “$X remaining” in your own dashboard.
  • Stop a batch job before it hits a 402 insufficient_funds mid-run.
  • Detect that a monthly cap is about to bite, while you can still raise it.

Request

No parameters.

Response 200

Two independent limits, and either one can produce a 402: an empty balance_usd gives insufficient_funds, and hitting monthly_cap_usd gives monthly_cap_exceeded. A healthy balance does not guarantee the next call goes through if the cap is close.
Same numbers appear in the billing block of GET /v2/me/usage — one source, two shapes. Use /v2/balance when you only need the money and not the call history.

Authorizations

Authorization
string
header
required

Your aeg_… API key from the dashboard (Account → API tab).

Response

200 - application/json

Successful Response

The response is of type Response Get Account Balance Balance Get · object.