Knowledge Base API

A knowledge base article captures a fix or a how-to so it can be reused. This API drives the full lifecycle: draft an article, write its body, then publish it or archive it when it goes stale.

Draft, then write

Create the article with POST /kb-articles to get a draft and an ID. The body lives separately: read and edit it through GET /kb-articles/{id}/content and PUT /kb-articles/{id}/content, so you can revise the text without touching the article's metadata. Start from a GET /kb-articles/templates entry, or turn a resolved ticket into an article with POST /kb-articles/from-ticket/{ticketId}.

Publish or archive

An article isn't visible until you call POST /kb-articles/{id}/publish. When it's outdated, take it down with POST /kb-articles/{id}/archive rather than deleting — archiving keeps the history. Reserve DELETE /kb-articles/{id} for articles that should leave no trace.

Browse and organize

List articles with GET /kb-articles, fetch one's metadata with GET /kb-articles/{id}, and read the category list from GET /kb-articles/categories to file an article where readers will find it.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.