Get article

Read an article as Markdown, with its site, topic, public address and whether its published copy is up to date with the page behind it.

GET/v1/w/{workspace}/help-articles/{id}

Path parameters

workspacestringrequired

Your workspace’s address name.

idstringrequired

The article, like ka_…, from List sites or Search articles.

Response

idstringrequired

titlestringrequired

publishedbooleanrequired

upToDateboolean

siteobjectrequired

topicstring

urlstring

pageIdstringrequired

markdownstringrequired

untrustedstring[]

Details

Read a help article as readers see it, as Markdown, with its site, topic, public address, when it was published and whether its page has edits readers do not see yet (upToDate). Links to other articles on the site show as [[Title]] and are listed with their addresses. A draft returns only its pageId, for get_page.

Since 2026-12. Errors are listed in Errors.

cURL

curl "https://api.olamma.sh/v1/w/your-workspace/help-articles/{id}" \
  -H "Authorization: Bearer $OLAMMA_KEY"

Response 200

{
  "id": "<string>",
  "title": "<string>",
  "published": true,
  "upToDate": true,
  "site": {
    "id": "<string>",
    "name": "<string>"
  },
  "topic": "<string>",
  "url": "<string>",
  "pageId": "<string>",
  "markdown": "<string>",
  "untrusted": [
    "<string>"
  ]
}