Skip to main content
GET
Core - Retrieve key metadata
Related guide: API keys guide. See the API keys guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

api_key_id
string
required

Unique identifier of the API key.

Response

API key retrieved successfully.

id
string
required
name
string
required
workspace_id
string
required
token
string
required

Raw on create; the key prefix on retrieve and update; masked in list responses.

active
boolean
is_legacy
boolean
source
string
budget
object
expiration
string<date-time>
projects
string[]
created_by_id
string | null
updated_by_id
string | null
created
string<date-time>
updated
string<date-time>
consumption
number
token_consumption
number
requests_per_minute_consumption
number
owner
object
project_scope
object
permission_mode
string
access
object
token_prefix
string
status
string
constraints
object
mcp_access
object
legacy_token_family
string
legacy_key_id
string
last_used_at
string<date-time>