Get an API key

Return a single key with its current usage.

Authentication

AuthorizationBearer

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

Path parameters

key_hashstringRequired

The key’s hash from a create or list response.

Response

The key.

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.

namestring or nullOptional

User-set name for the key.

limitdouble or nullOptional

Spend cap in USD over the reset window. Null means no cap.

limit_resetenumOptional

Window the spend cap resets on. Resets at midnight UTC.

Allowed values:

limit_remainingdouble or nullOptional

Remaining spend in USD before the cap. Null when no limit is set.

created_atdatetime or nullOptional

When the key was created.

project_idstring or nullOptional

Project the key is scoped to, or null for an organization-wide key.

allowed_modelslist of strings or nullOptional

Models the key may call; null means unrestricted and an empty list blocks every model.

routing_policy_idstring or nullOptional

Routing policy bound to the key, if any.

Errors

401

Unauthorized Error

404

Not Found Error