Skip to main content
GET
Python
Returns credential introspection for the calling API key: its workspace, granted scopes, capability profile, rate limits, and expiry. The response reflects current state. Any valid active API key can call this endpoint; no scope is required.

Authorizations

Authorization
string
header
required

API key authentication. Keys start with ak_ prefix. Example: Authorization: Bearer ak_live_xxxxxxxxxxxx

Response

API key identity

credential_type
enum<string>
required

The authentication scheme used by the caller.

Available options:
api_key
status
enum<string>
required

Always "active" on success — disabled or expired keys fail authentication with 401 before this response is produced.

Available options:
active
profile
enum<string>
required

Capability class derived server-side from the key's scopes.

Available options:
inference,
management,
mixed
key_id
string<uuid>
required

The API key's resource ID (not a secret).

key_prefix
string
required

The key's display prefix (e.g. "ak_live_abc1").

key_name
string
required

Human-readable key name.

workspace
object
required

The workspace this key is scoped to.

scopes
string[]
required

Granted scopes for fine-grained capability decisions.

rate_limits
object
required
expires_at
string<date-time> | null
required

Key expiry, or null if the key does not expire.

created_at
string<date-time>
required