Knowledge Base API
POST/api/v1/kb-articles
Product availabilityAlgaPSAAlgaDesk

Create a knowledge base article

Creates a KB article: generates a unique slug, creates the backing document record, and optionally stores initial block content. Returns the created article.

RBAC · document

Request body

Content type: application/json · schema KbArticleCreateRequest

titlestringRequired
min length 1 · max length 255
slugstring
Optional; generated from the title when omitted.
article_typestring
Defaults to how_to.
Enum: how_tofaqtroubleshootingreference
audiencestring
Defaults to internal.
Enum: internalclientpublic
category_idstring <uuid>
review_cycle_daysinteger
contentstring
Initial body content.
content_formatstring
Defaults to markdown.
Enum: markdownblocknote

Response body

Success response 201 · schema KbArticleResponse

dataobjectRequired
A knowledge base article and its metadata.
article_idstring <uuid>Required
tenantstring <uuid>Required
document_idstring <uuid>Required
Underlying document backing the article.
titlestringRequired
slugstringRequired
article_typestringRequired
Enum: how_tofaqtroubleshootingreference
audiencestringRequired
Enum: internalclientpublic
statusstringRequired
Enum: draftreviewpublishedarchived
category_idstring <uuid>Nullable
review_cycle_daysintegerNullable
next_review_datestringNullable
published_atstringNullable
published_bystring <uuid>Nullable
document_namestringNullable
Joined from the documents table.
created_atstring
updated_atstring
metaobject

Response codes

201
Article created.
400
Invalid request.
401
API key missing/invalid.
403
Caller lacks the required document permission.
500
Unexpected error.