← Back

API documentation

The API key management endpoints require an admin bearer token. This is a foundation for future user-facing OAuth and multi-tenant projects.

GET/api/v1/health

Returns service health.

POST/api/v1/keys

Create a new scoped API key; key is returned only once.

GET/api/v1/keys

List key metadata without exposing secrets.

DELETE/api/v1/keys/:id

Revoke a key.

GET/api/v1/example

Authenticate via an issued API key.

Requests must use HTTPS. Never embed your admin token or API keys in client-side JavaScript.