Kumkuat API reference
This reference is generated from the API's own OpenAPI 3.1 specification, the same document that drives the Swagger UI at https://api.kumkuat.ai/docs. Regenerate it with npm run gen-api-docs after the API changes.
Authentication
Send a workspace API key in the X-API-Key header on every request. Mint keys under Workspace → Integrations → API keys in the app, or with the Authentication endpoints below. Endpoints under /api/public/ take no key; they exist for the app's sign-in flow.
curl -H "X-API-Key: $KUMKUAT_API_KEY" https://api.kumkuat.ai/api/v1/personas
Groups
| Group | Covers |
|---|---|
| Authentication & API keys | Mint, list, rotate and revoke keys; resolve a user to their workspaces |
| Workspace | The current workspace and its extracted tag vocabularies |
| Personas & audiences | Personas, grounding, refinements, drift and health checks, reactions, interactions, audience summaries |
| Documents & content | Upload, ingest, query and tag documents; the content-writing endpoints |
| Signals & themes | Signal templates, theme filters and runs |
| Auto tags | Tag definitions, aliases and normalisation |
| Reports | Custom reports, sections, generation, PDF and scheduling |
| Alerts | Composer helpers |
Each endpoint page shows parameters, request body, response schemas and a request panel you can run against the API with your own key. See REST API for conventions.