Authentication
API keys are minted from the dashboard and passed via the x-api-key header.
Get a key
- Sign up for an account.
- Open the dashboard.
- Mint a key with a memorable label (e.g.
pattern-admin). - Copy the plaintext now. We only store a SHA-256 hash — the plaintext is shown once and never again.
Send it
Pass the key in the x-api-key request header:
Revoke
Hit the Revoke button next to the key in the dashboard. Calls using a revoked key return 401 revoked_key immediately.
Key prefix
The first 14 chars of each key (e.g. vk_live_a3f9c2) are stored in plaintext as the prefix. The dashboard shows this; we also return it on successful responses as the x-api-key-prefix header for log correlation.