Skip to content
Numes

API reference · Create key

Keys

Create key

Create an inference key with a management key. The secret is returned once.

POSThttps://api.numes.ai/api/v1/keys

billing_currency is required, must be enabled for the account, and can never change. limit_reset requires a limit; expires_at must be a future UTC timestamp. Store the returned key immediately — it is never shown again. Guide: Management keys.

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

Request body

application/json

The contract declares a 32 KiB body limit. The size the service enforces is listed in Limits.

namestringRequired
Length1–100
billing_currencyenum<string>Required

Required, non-null immutable settlement currency for the inference key. Must be enabled for new operations.

One ofUSDBTC
limitnumber | null
Range≥ 0
limit_resetenum<string> | null
One ofdailyweeklymonthly
expires_atstring<date-time> | null

Responses

201Created API key; the secret is returned only here.application/json

Headers

X-Request-Idstring

Correlation identifier assigned or accepted by the service.

BodyCreateKeyResponseapplication/json

dataobjectRequired
Show15 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
billing_currencyenum<string>

Immutable settlement currency; omitted for management keys.

One ofUSDBTC
keystringRequired

One-time plaintext key secret.

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