Search articles

Find articles the way a reader would: in their own words, across every site or one. Use it to answer a customer from your published help.

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

Path parameters

workspacestringrequired

Your workspace’s address name.

Query parameters

querystringrequired

What to look for, in the reader’s words.

siteIdstring

Only this site.

limitinteger

How many results, 1 to 20. Defaults to 8.

Response

resultsobject[]required

Details

Search what readers see on the workspace's help sites: published articles only, best match first, each with its site, topic, public address and a snippet. Use it to answer a question from the help content, then get_help_article to quote one.

Since 2026-12. Errors are listed in Errors.

cURL

curl -G "https://api.olamma.sh/v1/w/your-workspace/help-articles" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  --data-urlencode 'query=how do I top up by bank transfer' \
  --data-urlencode 'limit=5'

Response 200

{
  "results": [
    {
      "id": "<string>",
      "title": "<string>",
      "site": {
        "id": "<string>",
        "name": "<string>"
      },
      "topic": "<string>",
      "url": "<string>",
      "snippet": "<string>"
    }
  ]
}