Browse the documentation

Free

Read your account

GET/api/v1/accountFree
Scope
any developer scope
Price
Free

What this key is, what it may do, what the balance is and what has been used in the last 30 days. Free: checking a balance should never cost anything.

What to know

  • FREE. No charge, no model call, nothing taken from the balance.
  • Readable by any valid developer key whichever scopes it holds. A key minted only for chat can still read the balance it is spending from.
  • USAGE LAGS BY A FEW MINUTES. Rows are queued and drained on a five-minute cycle, so a call you made seconds ago may not appear yet. The balance is live; the usage rollup is not.
  • Only the key prefix is returned. The full secret exists once, at mint, and is never retrievable.

Example request

curl
curl "https://www.revisiongenie.com/api/v1/account" \
  -H "Authorization: Bearer rgk_live_YOUR_KEY_HERE"

Example response

json
{
  "key": {
    "prefix": "rgk_live_Ab",
    "name": "Production",
    "scopes": ["curriculum:read", "ai:chat"]
  },
  "scopes": ["curriculum:read", "ai:chat"],
  "companyName": "Lesson Planner Ltd",
  "billing": {
    "balancePence": 4808,
    "lifetimeSpentPence": 192,
    "lifetimePurchasedPence": 5000,
    "currency": "GBP",
    "paidEndpointsEnabled": true
  },
  "usage30d": {
    "windowDays": 30,
    "since": "2026-08-09T00:00:00.000Z",
    "totalCalls": 48,
    "byAction": { "chat": 40, "examQuestionGeneration": 8 },
    "note": "Usage is aggregated from queued events and can lag live calls by a few minutes."
  }
}

Errors

Every error carries the same shape: a stable error code to branch on and a message for a human. Codes specific to this endpoint come first.

CodeStatusWhen
invalid_key401The key is missing, malformed, revoked, expired, or is not a developer key.
forbidden403The key is valid but does not hold the scope this endpoint requires.
suspended403The developer account is suspended. Data reads stop as well as billable calls.
rate_limited429The key went past its ceiling: 120 calls a minute overall, 30 a minute on the paid endpoints. Also returned after repeated failed authentication from one address.
server_error500Something failed on our side. Retry; a paid call is refunded.

Revision Genie is an independent product and is not affiliated with or endorsed by AQA, Pearson Edexcel, OCR, WJEC or Eduqas.

Use of this API is governed by the developer terms. Questions: support@revisiongenie.com.