Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kataven.ai/llms.txt

Use this file to discover all available pages before exploring further.

sk_live_ server-to-server credentials. Listing endpoints work with any auth; CRUD operations are gated to the Hub UI — a leaked sk_live_ cannot mint another. Mint via hub.kataven.ai/settings → API Keys.

​
Endpoints at a glance

MethodPathSummary
GET/api/v1/api-keysList API keys
POST/api/v1/api-keysCreate an API key (returns plaintext sk_live_ ONCE)
PATCH/api/v1/api-keys/{id}Update or revoke an API key
DELETE/api/v1/api-keys/{id}Delete or soft-disable an API key

​
Reference

​
GET /api/v1/api-keys

List API keys Returns metadata for every sk_live_ key in this account. Plaintext key values are never returned — only the last 8 characters and the row id. Responses
CodeDescriptionBody
200OKarray<data.ApiKey>
400Missing X-Account-ID headerstring
401Missing or invalid bearer tokenstring
500Database errorstring
Example 
curl https://api.kataven.ai/v1/api-keys \
  -H "Authorization: Bearer $KATAVEN_API_KEY"

​
POST /api/v1/api-keys

Create an API key (returns plaintext sk_live_ ONCE) Mints a new sk_live_ credential. The plaintext value is returned in the response and never again — store it in your secret manager. Requires Hub UI (Zitadel) auth; sk_live_ keys cannot mint other sk_live_ keys. Request body (application/json) Schema: handlers.CreateApiKeyRequest. Server-set fields (id, created_at, updated_at, …) are ignored if supplied; only the user-settable fields are shown below.
FieldTypeDescription
expirystringe.g. 90d
namestringe.g. ci-deploy-bot
Responses
CodeDescriptionBody
201Createddata.CreatedApiKey
400Invalid body or name requiredstring
401Missing or invalid bearer tokenstring
403Requires Hub UI authstring
500Database errorstring
Example 
curl https://api.kataven.ai/v1/api-keys \
  -X POST \
  -H "Authorization: Bearer $KATAVEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expiry": "90d",
  "name": "ci-deploy-bot"
}'

​
PATCH /api/v1/api-keys/{id}

Update or revoke an API key Renames the key or revokes it (disabled=true sets disabled_at=now() — idempotent). Requires Hub UI (Zitadel) auth so a leaked sk_live_ cannot disable other keys. Parameters
NameInTypeRequiredDescription
idpathstringYesAPI key id (uuid)
Request body (application/json) Schema: handlers.UpdateApiKeyRequest. Server-set fields (id, created_at, updated_at, …) are ignored if supplied; only the user-settable fields are shown below.
FieldTypeDescription
disabledbooleane.g. False
namestringe.g. ci-deploy-bot-renamed
Responses
CodeDescriptionBody
204Updated—
400Invalid bodystring
403Requires Hub UI authstring
500Database errorstring
Example 
curl https://api.kataven.ai/v1/api-keys/agent_01HZ2N... \
  -X PATCH \
  -H "Authorization: Bearer $KATAVEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "disabled": false,
  "name": "ci-deploy-bot-renamed"
}'

​
DELETE /api/v1/api-keys/{id}

Delete or soft-disable an API key Hard-deletes the row if the key was never used; otherwise sets disabled_at=now() to preserve the audit trail. Requires Hub UI auth. Parameters
NameInTypeRequiredDescription
idpathstringYesAPI key id (uuid)
Responses
CodeDescriptionBody
204Deleted—
403Requires Hub UI authstring
500Database errorstring
Example 
curl https://api.kataven.ai/v1/api-keys/agent_01HZ2N... \
  -X DELETE \
  -H "Authorization: Bearer $KATAVEN_API_KEY"