API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Api Keys

AdminUpdated Sep 11, 2026

Api Keys

Backend API — secret key (Authorization: Bearer sk_…).

6 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/api_keys

api_keys:read

List end-user API keys the tenant minted for its users/organizations. Never the secret.

POST /v1/api_keys

api_keys:write

Mint an end-user API key for a user or organization. Returns the ak_ secret once.

POST /v1/api_keys/verify

api_keys:read

Verify a presented ak_ secret. Returns the subject + claims, or valid:false. Rate-limited.

GET /v1/api_keys/:id

api_keys:read

Read one end-user API key by id (prefix + metadata, never the secret).

PATCH /v1/api_keys/:id

api_keys:write

Update an end-user API key: name, claims, or expiry.

DELETE /v1/api_keys/:id

api_keys:write

Revoke an end-user API key. It stops verifying immediately; the record is kept.

Was this page helpful?
Api Keys