Docs/Reference/Usage/Get Usage
GET/v1/usage

Get Usage

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope. data contains UsageOut.

Envelope

dataUsageOut

A single result object.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

UsageOut

key_prefixstring

First 8 characters of the API key for identification.

tierstring

Current pricing tier (e.g. 'free', 'pro').

requests_todayinteger

Number of API requests made today.

default 0
daily_limitinteger | null

Daily request limit for current tier, null if unlimited.

burst_limitinteger

Max requests per second for current tier.

default 2

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.