Find articles mentioning changed symbols

Given symbols changed in a code diff (API endpoints, flags, feature labels, routes), returns the articles whose title or body mentions any of them — for detecting stale docs after a code change. Best-effort substring match. Scope: content:read.

POSThttps://api.helpbento.com/v1/articles/find-references

Authentication

AuthorizationstringheaderBearer <token>required

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

Request body

application/jsonrequired

symbolsarray of stringrequired
Changed names to look for, e.g. ["/api/v2/users", "FLAG_BETA_MODE"].
knowledgeBaseIdstring
Restrict to one KB; default searches all.

Responses

itemsarray of SymbolMatch

Errors

curl -X POST "https://api.helpbento.com/v1/articles/find-references" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "symbols": [
    "string"
  ],
  "knowledgeBaseId": "string"
}'

{
  "items": [
    {
      "symbol": "string",
      "articleCount": 0,
      "articles": [
        {
          "articleId": "string",
          "title": "string",
          "slug": "string",
          "status": "draft",
          "matchSnippet": "string"
        }
      ]
    }
  ]
}

Authentication

Request body

Responses

Was this page helpful?