Articles
Help centers allow organizations to create and manage knowledge bases with articles and collections. Currently, Featurebase supports one help center per organization.
List articles
Create an article
Get an article by ID
Update an article
Delete an article
Edit an article body (find/replace)
Search articles
ModelsExpand Collapse
Article object { id, availableLocales, createdAt, 27 more }
translations: optional object { id, bg, bn, 39 more } Translations by locale code
Translations by locale code
EditArticleBodyBody object { newText, oldText, dryRun, 4 more }
Replacement text. Keep this to a fragment, not a whole document (max 10000 chars). May be an empty string to delete the matched fragment. When the match came from tier 2 (raw markup), the full resulting body is re-run through the XSS sanitizer, so any dangerous markup in newText is stripped. Images inserted via edit_body are not uploaded to Featurebase storage — use articles.update with formatter ‘raw’ for image changes.
Exact fragment to find in the stored article body. Keep this to a fragment, not a whole document (max 10000 chars). Tier 1 matches only inside TEXT nodes (markup, tags, and attributes are never searched or altered) and is entity-aware, so oldText: "A & B" matches a stored A & B. If tier 1 finds nothing, tier 2 falls back to a literal substring match over the raw body string (markup included). Do NOT include <img> tags — their stored src differs from the API representation and will not match.
Preview the edit without writing. Returns the match count, matching mode, and previews (changed spans with surrounding context) so an agent can verify the edit before committing. Recommended workflow: dry-run across a set of articles first, confirm the counts and previews, then re-issue each call with dryRun: false.
Assert the exact number of matches. When set, the edit replaces all matches only if the count is exactly this value, otherwise it returns 400. Takes precedence over replaceAll. Use this to make bulk edits safe: dry-run first to learn the count, then commit with the expected number.
locale: optional "bn" or "bs" or "pt-BR" or 39 moreLocale of the body to edit. Defaults to the help center’s default locale.
Locale of the body to edit. Defaults to the help center’s default locale.
EditArticleBodyResponse object { id, dryRun, locale, 6 more }
mode: "text" or "html"Which matching tier applied. text = text-node-only, byte-stable (markup untouched). html = raw-markup fallback (result re-sanitized). Tier 1 (text) is always attempted first.
Which matching tier applied. text = text-node-only, byte-stable (markup untouched). html = raw-markup fallback (result re-sanitized). Tier 1 (text) is always attempted first.
ArticleSearchResponse object { data, nextCursor, object, 2 more }
data: array of object { id, availableLocales, createdAt, 27 more } Array of search results
Array of search results
translations: optional object { id, bg, bn, 39 more } Translations by locale code
Translations by locale code