Skip to main content
GET
GET /v1/usage Current billing cycle of the calling key: plan, credits used, limit and remaining, request count. The programmatic view of your own key and account, the data behind a usage dashboard. Free: never billed, and still reachable when the monthly credit allowance is exhausted (when billable endpoints answer 402), so you can always inspect your own state. A key only ever sees its own account.
month is the current calendar month (YYYYMM, UTC), and credits.used counts the usage of that month. When your reset date is not the 1st, your billing period runs from one reset date to the next: the portal shows its totals. For keys created in the portal, scope is "account": credits and requests cover the whole account (all its keys share one allowance), tenant is the account id and credits.limit is what the account can still reach this month (free credits left on pay as you go, or the included credits on Growth, plus what the spend cap allows). plan is the name of your current plan, as the portal shows it: "Pay as you go", "Growth 10M", or the name of a custom plan (Plans); it is null while the account is being set up. Contract keys report scope: "key" and their own figures; on an unlimited contract, credits.limit and credits.remaining are null.
A key of an account can also carry its own monthly limit inside the account’s allowance (on enterprise accounts, set with us: a staging key that can never use up the production key’s credits). Its response then adds keyCredits (used, limit, remaining) for that key alone; calls stop at whichever limit is reached first.
The same figure is on every billable response: the X-Credits-Remaining header carries the credits left in the current cycle.

Authorizations

Authorization
string
header
required

Your raw API key (not needed on the demo server).

Response

200

Standard { data, meta } envelope.