The complete usage guide for the Knowledge Base module of the REST API — every URL, method, parameter and response shape. Mirrors the interactive documentation at System → API → Documentation (with its live "Try it" tester).

What's distinctive about Knowledge:

Sync a runbook from your docs pipeline into the KB:

B="https://your-server/api/v1"; K="Authorization: Bearer fitsm_…"

curl -X POST "$B/knowledge/articles" -H "$K" -H "Content-Type: application/json" -d '{
  "title": "How to reset your VPN token",
  "body_html": "<h2>Steps</h2><ol><li>Open the portal</li><li>Click reset</li></ol>",
  "tags": ["vpn", "how-to"],
  "next_review_date": "2026-12-01"
}'

Published immediately, tagged, embedded for AI search, and on the review calendar. 📖

Published articles (or the recycle bin with archived=true). Each list item carries a 300-character plain-text preview instead of the full body.

Articles are created published immediately — the product has no draft workflow. Returns 201 with the full article.

The full article with body_html, tags, version number and a has_embedding flag. Add ?count_view=true to count the read as a view (UI parity — otherwise machine reads leave the stats alone).

{ "data": { "id": 26, "title": "How to reset your VPN token",
    "tags": ["how-to", "vpn"],
    "author": { "id": 1, "name": "Administrator" }, "owner": null,
    "version": 2, "view_count": 41, "next_review_date": "2026-12-01",
    "is_archived": false,
    "created_at": "2026-07-03T12:18:31Z", "modified_at": "2026-07-03T12:19:07Z",
    "body_html": "<h2>Steps</h2><ol>…</ol>", "has_embedding": true } }

The search embedding is refreshed automatically after every create/update (when the OpenAI key is configured). An archived article answers 409 — restore it first.

Soft-archives the article. It stays restorable until the module's retention window (knowledge_recycle_bin_days, default 30; 0 = keep forever) purges it.

Brings an archived article back, exactly as it was.

Snapshots are only created when a save says so (save_as_version here, "Save as new version" in the UI) — routine edits update in place.

The saved snapshots — version number, title at the time, who saved it, when — newest first.

One snapshot including its full body_html — everything needed to diff or roll back (roll back by PATCHing the old body onto the article).

Every tag with its published-article count:

{ "data": [ { "id": 3, "name": "how-to", "article_count": 12 },
            { "id": 7, "name": "vpn", "article_count": 4 } ] }

A CI job that keeps the KB in step with a docs repo (knowledge: read, create, update + reference: read):

B="https://your-server/api/v1"; K="Authorization: Bearer fitsm_…"

# Upsert-by-title: find the article, PATCH it (with a version snapshot) or create it
ID=$(curl -s -H "$K" "$B/knowledge/articles?q=$(python3 -c 'import urllib.parse;print(urllib.parse.quote("How to reset your VPN token"))')" | jq -r '.data[0].id // empty')
if [ -n "$ID" ]; then
  curl -s -X PATCH "$B/knowledge/articles/$ID" -H "$K" -H "Content-Type: application/json" \
    -d "{\"body_html\": $(jq -Rs . < rendered.html), \"save_as_version\": true}"
else
  curl -s -X POST "$B/knowledge/articles" -H "$K" -H "Content-Type: application/json" \
    -d "{\"title\": \"How to reset your VPN token\", \"body_html\": $(jq -Rs . < rendered.html), \"tags\": [\"vpn\"]}"
fi

And the review-cycle report — what's overdue for review, and who owns it?

curl -s -H "$K" "$B/knowledge/articles?review=overdue&sort=next_review_date&per_page=100" \
  | jq -r '.data[] | [.title, .next_review_date, (.owner.name // "unowned")] | @tsv'

Under the hood: REST API — How It Works · Other modules: Tickets · Assets · Problems · Changes · Keys & permissions: System → API (System module) · Module docs: Knowledge.