Semantic search

Semantic search over one knowledge base's published articles. Scope: search:read.

GEThttps://api.helpbento.com/v1/search

Authentication

AuthorizationstringheaderBearer <token>required

An API key, e.g. hb_live_… (live) or hb_test_… (test).

Query parameters

3 params

qstringlength: 0…500required
knowledgeBaseIdstring
Defaults to the company default KB.
limitintegerdefault: 10range: −∞…25

Responses

itemsarray of SearchResult

Errors

curl -X GET "https://api.helpbento.com/v1/search?q=%3Cq%3E" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "items": [
    {
      "article": {
        "id": "string",
        "slug": "string",
        "title": "string",
        "excerpt": "string",
        "tags": [
          "string"
        ],
        "status": "draft",
        "categoryId": "string",
        "knowledgeBaseId": "string",
        "publishedAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-01T00:00:00Z"
      },
      "similarity": 0
    }
  ]
}

Authentication

Query parameters

Responses

Was this page helpful?