Add article

Place a page in a topic as a help article. It starts as a draft that readers can’t see; publish it to show it on the site. A page already on the site moves to the new topic.

POST/v1/w/{workspace}/help-articles

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Body

topicIdstringrequired

The topic, like kc_…, from List sites.

pageIdstringrequired

The page to show, like pg_…, from List pages.

Response

articleobjectrequired

movedbooleanrequired

true when the page was already an article and moved topic.

Details

File a saved page under a help topic without publishing it.

Since 2026-12. Errors are listed in Errors.

cURL

curl -X POST "https://api.olamma.sh/v1/w/your-workspace/help-articles" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  -H "Idempotency-Key: <unique key>" \
  -H "content-type: application/json" \
  -d '{
    "topicId": "kc_…",
    "pageId": "pg_…"
  }'

Response 201

{
  "article": {
    "id": "<string>",
    "siteId": "<string>",
    "pageId": "<string>",
    "status": "<string>"
  },
  "moved": true
}