Management APIAPI keys

Create an API key

Mint a new API key. The raw key is returned exactly once in the key field. Pass an optional limit and limit_reset to attach a spend cap.

Authentication

AuthorizationBearer

A management key (prefixed mgmt_), created in the dashboard under Settings, API keys, Management keys. Distinct from a regular gateway API key, and never used to call models.

Request

This endpoint expects an object.
namestring or nullOptional

A name for the key, for example customer-acme or [email protected]. Shown in the dashboard and usage views.

limitdouble or nullOptional
Optional spend cap in USD over the reset window.
limit_resetenumOptional

Window the spend cap resets on. Required if limit is set.

Response

The created key, including the raw secret.
hashstring

Stable identifier for the key. A one-way hash, not the secret, so it is safe to store and log. Use it in get, update, and delete calls.

labelstring

Display label (the key’s public prefix, e.g. mg_8Kx2pQ). Not the secret.

disabledboolean
Whether the key is disabled. A disabled key cannot call the gateway but is not deleted.
usagedouble
Spend in USD in the current reset window.
keystring

The raw API key (prefixed mg_). Shown exactly once, at creation. Store it now; it cannot be retrieved later.

namestring or null

User-set name for the key.

limitdouble or null
Spend cap in USD over the reset window. Null means no cap.
limit_resetenum
Window the spend cap resets on. Resets at midnight UTC.
limit_remainingdouble or null
Remaining spend in USD before the cap. Null when no limit is set.
created_atdatetime or null
When the key was created.

Errors

400
Bad Request Error
401
Unauthorized Error