Skip to main content
GET
Retrieve an API key

Authorizations

Authorization
string
header
required

A management key (created from the organization dashboard or with POST /v3/manage/auth-keys), sent as Authorization: Bearer <management_key>. Inference API keys (sk-eden...) are not accepted on these endpoints.

Path Parameters

key_id
string<uuid>
required

Response

200 - application/json

An API key belonging to the organization. The secret is never included: masked shows the key prefix and last characters for identification, and id is the stable identifier used in /manage/keys/{key_id} URLs.

balance is the remaining spendable amount, including usage not yet settled, or null when the key has no spending cap. Revoked keys stay listed with revoked: true and a revoked_at timestamp. id is null for a legacy key that has not been regenerated yet; such a key is listed but cannot be addressed by URL until it is regenerated.

id
string<uuid> | null
required
read-only
name
string
required

The token name

Maximum string length: 200
member
string<email>
required
read-only
masked
string
required
read-only
balance
number<double> | null
required
read-only
Required range: -100000 < x < 100000
revoked
boolean
required
read-only
token_type
enum<string>
  • sandbox_api_token - Sandbox
  • api_token - Back
Available options:
sandbox_api_token,
api_token
active_balance
boolean

Weither to use the balance field or not.

expire_time
string<date-time> | null
revoked_at
string<date-time> | null