Skip to content
Numes

API reference · Get credits

Credits

Get credits

Get your account's total credits and settled usage in one currency, using a management key.

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

Name exactly one currency with currency, USD or BTC; balances are held per currency and never combined. total_credits minus total_usage is the account's balance in that currency, without holds for running requests. BTC amounts are in satoshis. A missing or unknown currency returns 400. Per-key spending is available from Get current key.

Authorization

AuthorizationheaderRequired

Bearer management key. Management keys manage inference keys and cannot run inference. Authorization: Bearer $NUMES_MANAGEMENT_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

Query parameters

currencyenum<string>Required

Settlement currency to report. Required; there is no default currency.

One ofUSDBTC

Responses

200Credit totals in the requested settlement currencyapplication/json

Headers

X-Request-Idstring

Correlation identifier assigned or accepted by the service.

BodyCreditsResponseapplication/json

dataobjectRequired
Show3 child attributes
currencyenum<string>Required

The requested settlement currency; BTC values are Bitcoin base units.

One ofUSDBTC
total_creditsnumberRequired

Net posted non-usage movements (funding less refunds, disputes, withdrawals, and corrections) as an exact decimal.

total_usagenumberRequired

Lifetime settled usage charges as an exact decimal.

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