Skip to content
Numes

API reference · Get current key

Keys

Get current key

Inspect the key making the request — its limit, remaining budget, usage windows and expiry.

GEThttps://api.numes.ai/api/v1/key

Works with an inference key or a management key. Money values are in the key's billing currency (omitted for management keys) and are written from exact decimals. limit_remaining is floored at zero and uses the window selected by limit_reset. Guide: API keys.

Authorization

AuthorizationheaderRequired

Bearer inference key or management key. Authorization: Bearer $NUMES_API_KEY

Headers

X-Request-Idstring

Correlation ID, not an idempotency key. Inference request IDs recorded with a generation are unique per account. A traffic-admitted request reusing a recorded ID returns 400 invalid_request. Traffic admission rejection takes precedence over this conflict, including for reused IDs; it performs no generation lookup and writes no generation, result or attempt. Rate-limit rejection returns 429 rate_limited with Retry-After; an inference limiter outage retains 500 server.

Length1–128

Responses

200Current key metadataapplication/json

Headers

X-Request-Idstring

Correlation identifier assigned or accepted by the service.

BodyCurrentKeyResponseapplication/json

dataobjectRequired
Show16 child attributes
hashstringRequired
labelstringRequired
namestringRequired
disabledbooleanRequired
limitnumber | nullRequired
limit_remainingnumber | nullRequired
limit_resetenum<string> | nullRequired
One ofdailyweeklymonthly
usagenumberRequired
usage_dailynumberRequired
usage_weeklynumberRequired
usage_monthlynumberRequired
created_atstring<date-time>Required
updated_atstring<date-time> | nullRequired
expires_atstring<date-time> | nullRequired
is_management_keybooleanRequired
billing_currencyenum<string>

Immutable settlement currency; omitted for management keys.

One ofUSDBTC
ErrorCompatible error envelopeapplication/json

Headers

X-Request-Idstring

Correlation identifier assigned or accepted by the service.

Retry-Afterinteger

Optional delay in seconds for retryable rate or availability errors.

Range≥ 1

BodyErrorResponseapplication/json

errorobjectRequired
Show3 child attributes
codeintegerRequired
messagestringRequired
metadataobject
openrouter_metadataobject