Account and balance

Your balance, your ledger and your own activity are readable with your API key. Everything here is scoped to your account — there is no parameter that widens it.

Who am I

GET /v1/me

{"ok": true, "principal": {"consumerId": "…", "apiKeyId": "…",
 "name": "research-team-a", "scopes": ["jobs:create","jobs:read",
 "results:read","audit:read"]}}

Balance

GET /v1/me/balance

{"ok": true, "balance": {
  "balanceMicros": 50000000, "display": "50 USD",
  "toppedUpMicros": 50000000, "chargedMicros": 0, "currency": "USD"}}

Amounts are integer micros

One unit of currency is 1,000,000 micros. Money never touches a floating-point number anywhere in this system, and neither should it in yours: 0.1 + 0.2 is the oldest defect in accounting software.

50 USD  →  50000000 micros
0.001 USD (one tenth of a cent) →  1000 micros

Transaction history

GET /v1/me/transactions?limit=50&offset=0

Every movement is one append-only row recording the balance it produced, so any figure can be walked backwards without replaying the whole history.

Kind	Sign	Meaning
`TOPUP`	+	Funds added
`CHARGE`	−	Usage billed
`REFUND`	+	A charge reversed
`ADJUSTMENT`	±	A manual correction, always with a note

What is billed

Delivered pages. A task that ends DONE is billed; one that fails, is blocked, or is retried is not. You pay for pages we actually handed you.

Billing is applied per account and can be switched off entirely for an account during an evaluation. Your balance and your ledger tell you which state you are in: if chargedMicros stays at zero while you run traffic, nothing is being deducted yet.

Your API activity

GET /v1/me/auditaudit:read

Returns your own requests with status code, path, method and timestamp. Useful for confirming a rotated key has taken over before you revoke the old one.

Successful status polls are not recorded. They are excluded to keep the log readable, so this is a log of meaningful calls and errors, not a count of every HTTP request you made. Do not use it to reconcile a bill.

The customer portal

The portal shows the same data in a browser — balance, transactions, jobs, keys and usage — with a separate email and password login. Your API key is not a portal credential, and the portal password is not an API credential.

← Browser sessions Rate limits →