Skip to main content
GET
Get Own Usage (Sub-Key Self-Service)
This endpoint is authenticated with the sub-key itself, not the admin key. It is intended for scenarios where sub-key holders need to monitor their own remaining credits programmatically.
Authenticating with an admin key returns 403 Forbidden. Use GET /v1/api-keys/sub-keys/{key_id}/usage with the admin key to inspect a specific sub-key’s status.

Typical use case

A service that holds a sub-key can call this endpoint periodically to determine how much credit remains before being blocked:

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-key
string
required

The sub-API key itself (not the admin key). Sub-API key

Response

Successful Response

status
string
Example:

"succeeded"

data
KeyUsageData · object