Skip to content

Knowledge base API

9 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.

Method Path Description
GET /api/kb/articles List Articles Query: category_id, status, visibility, search, limit, offset.
POST /api/kb/articles Create Article Accepts a JSON body.
GET /api/kb/articles/{article_id} Get Article
PATCH /api/kb/articles/{article_id} Update Article Accepts a JSON body.
DELETE /api/kb/articles/{article_id} Delete Article
GET /api/kb/categories List Categories
POST /api/kb/categories Create Category Accepts a JSON body.
GET /api/kb/public/articles Public Articles Query: category, search, limit, offset.
GET /api/kb/public/articles/{slug} Public Article By Slug

Try it

The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.