Skip to main content
GET
Get API key

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

id
string<uuid>
required

Response

API key details

id
string<uuid>
required
project_id
string<uuid> | null
required
user_id
string<uuid>
required
name
string
required
key_prefix
string
required
last_used_at
string | null
required
expires_at
string | null
required
created_at
string
required
updated_at
string
required
status
enum<string>
required
Available options:
active,
expired,
revoked
revoked_at
string | null
required
scopes
string[]
required
scope
enum<string>
required

Whether the key is restricted to one project or applies to the account. An account-wide key acts with its owner’s project roles, limited by the key’s scopes. Unlike project-scoped keys, it can inherit the owner’s administrative authority: write can allow API key creation, and delete can allow project deletion.

Available options:
account,
project
budget
object | null
required

The subject’s monthly AI budget, or null if no budget is configured. Read-only; use /budgets to manage budgets.

budget_status
object | null
required

Usage against the budget for the current month, or null if the subject has no budget.