Skip to main content
POST
Create Api Key

Body

application/json
name
string
required

Human-readable label

Required string length: 1 - 255
scopes
string[]
required

Granted scopes

Minimum array length: 1
key_type
string
default:human

Key type: 'human' or 'agent'

expires_at
string<date-time> | null

Optional expiry (UTC ISO 8601)

allowed_sources
string[] | null

Restrict ingestion to these source names (null = unrestricted)

Response

Successful Response

data
APIKeyCreated · object
required

Returned only by POST /v1/api-keys. Contains the full plain-text key (shown once).

meta
Meta · object