HelpCenter.io for agents

Full-text search a HelpCenter.io help center's articles by query string, returning ranked matches. This performs keyword search (Meilisearch-backed) over published article titles and content for the connected help center. Use it to answer "find the article about X" intents. It is read-only and does not modify anything. For browsing by category rather than searching, use helpcenter_list_articles. Args: - query (string, required): search text matched against titles and content. - lang (string, optional): language code to search within (defaults to the site default). - category_id (number, optional): restrict to one category id. - include_content (boolean, optional): default false, so each match comes back WITHOUT its body (the fields are listed under helpcenter_list_articles). Read the matches you need with helpcenter_get_article. true adds every language's full body. - limit (number, optional): items per page, 1-100 (default 100). - page (number, optional): page number (default 1). - response_format ('markdown' | 'json'): default 'markdown'. Returns: a payload with { total, count, page, per_page, total_pages, has_more, next, items }, ranked best match first. Each item is an article without its body (see include_content), or with include_content: true the full article (id, per-language title/slug/content, category_id, categories, type, published, visibility, views, ratings, timestamps). Paging: every response carries next: { page, limit } — the exact arguments that fetch the first item it did not return — or null when nothing is left. Follow next, with the same filters, instead of computing page + 1 yourself. A response is capped at 25000 characters, in its text and in its structured data alike, and 5.0 MB in all: when a page does not fit, only its first items are returned (truncated: true, count says how many) and next points at the rest, usually with a smaller limit and a later page number. Requesting page + 1 with your original limit would skip t…

Connect the help center to the user's own domain (e.g. help.example.com), as its Settings page does. Then give the user the DNS record from the result to add at their DNS provider; the certificate is requested once the record points here, and the domain goes live minutes later. Follow it with helpcenter_get_custom_domain. Works once the user has claimed the help center, verified their email address and activated a plan; until then it answers capability_locked with the user's next step (helpcenter_get_help_center shows it too). Changing to a new domain counts against the help center's 4 changes a month and stops the old domain answering: only set the domain the user asked for. Setting the domain it already has changes nothing. Refused when another help center already holds the domain (domain_taken). Args: - domain (string, required): a host name, without http(s):// or a path. Returns: { custom_domain } as helpcenter_get_custom_domain answers it.

Replace the help center's navigation menu — the one every Navigation component draws, in the header or elsewhere — with the items given, in order. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. The whole menu is replaced: include every item to keep, with its id (helpcenter_get_template, section 'navigation'), so its translations survive; an empty list clears it. Links are '/', '/category/<id>' (ids from helpcenter_list_categories), '/content/<article slug>', '/contacts', or a full https:// URL with type 'external' to open in a new tab. Items take one level of children, and a cssClass to style one — a button-like "Sign up" — with custom CSS. This is the guide's `set_navigation` operation. Args: - items (array, up to 30): {label, href, type?, cssClass?, id?, children?}. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Save an edit to a published article WITHOUT readers seeing it. Nothing goes live until you call helpcenter_publish_staged_changes. Staged changes let you edit a PUBLISHED article without readers seeing it, then release it deliberately. Staged content is invisible to everything public: the rendered help center, sitemap, site search, the widget, the AI answer path, and this API's read endpoints. Staged versions are held per article AND per language, so an English hot fix is never held back by an in-progress Portuguese translation. Prefer this over helpcenter_update_article whenever the article is already published and the change should not appear the instant you write it — a rewrite in progress, a coordinated multi-language update, anything wanting review. This is a PATCH over the staged copy: fields you omit keep whatever was staged before, they are not cleared. Unlike the live article endpoints, the text fields here are plain strings, because a staged version IS one language — named by the required `locale`. Args: - article_id (number, required): must be a PUBLISHED article. - locale (string, required): the language this version is for. - title, content, slug (strings, optional): a title-only change does NOT rename the URL; send slug to rename. The redirect from the old address is created at publish, never here — so a staged rename cannot redirect live traffic while still private. - category_id, categories, visibility (optional): these belong to the ARTICLE, not a language. Sibling staged languages published together must agree on them, or publish refuses with 422 naming the field and the two locales. - release_translation (boolean, optional): mark this language released when the change is published. - etag (string, optional): pass the one from your last read; a mismatch returns 409 STALE_ETAG with the current value, meaning somebody else moved the staged copy — re-read, re-apply, retry. Returns: { status: "success", staged: { locale, fields, etag…

Make a region one shared copy on every page, or let each page keep its own. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. header and footer are synced by default: one region mirrored to all six pages under the same component ids. enabled:false unsyncs it, and each page keeps its own copy (same ids), so later edits name the page. enabled:true makes every page take source_page's version (default home), translations included, replacing the other pages' copies wherever they differ. An edit to a synced region whose pages differ is refused until you run this, either way. main cannot be synced. This is the guide's `sync_region` operation. Args: - region: header, hero, sidebar, footer or utility. - enabled (boolean): share it (true) or let pages differ (false). - source_page (optional): when enabling, the page every page copies. Default home. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Update an existing article by id in the connected HelpCenter.io help center. Partial update: only the fields you pass are changed. Requires a write-scoped API key. Per-language fields (title, content, slug) are objects keyed by language code and merge per language. Args: - article_id (number, required): id of the article to update. - title, content, slug (objects, optional): per-language fields to set. - category_id (number, optional): primary category id. - categories (number[], optional): replace the set of additional categories. - type ('article' | 'faq', optional). - visibility ('public' | 'private' | 'link_only', optional). - published (boolean, optional): true publishes, false reverts to draft. - external_id (string, optional): adopt this article under a stable key you own, so later upserts by that key hit this article. - content_format ('html' | 'markdown', optional): defaults to 'html'. Set 'markdown' when sending markdown, or the raw markup is stored as the body. - rehost_images (boolean, optional): ON by default through this connector. Copies externally hosted images in the content you send into this help center's storage (see helpcenter_create_article). Send false to keep the original image URLs. IMPORTANT — this writes LIVE. On a published article the change is visible to readers immediately. To prepare an edit privately and release it deliberately, use helpcenter_stage_article_changes and helpcenter_publish_staged_changes instead. Returns: { status: "success", article: {...}, images? } with the updated article; images reports re-hosted and failed images as for helpcenter_create_article. Errors: 403 if the key is read-scoped; 404 if the article id is not in this help center; 400 for unsupported language codes or invalid category ids.

Update an existing category by id in the connected HelpCenter.io help center. Partial update — only fields you pass change. Requires a write-scoped API key. Name and description are per-language objects keyed by language code. Args: - category_id (number, required): id of the category to update. - name (object, optional): per-language category name. - description (object, optional): per-language description. - parent_id (number, optional): id of the parent category for nesting (must belong to this site). Use 0 to make the category top-level. - icon (string, optional): icon identifier, max 190 chars. - position (number, optional): sibling order, ascending. To move several categories at once use helpcenter_reorder_categories instead. Returns: { status: "success", category: {...} } with the updated category. Errors: 403 if the key is read-scoped; 404 if the category id is not in this help center; 422 for unsupported language codes, an invalid parent_id, or a parent that would make the tree a loop (a category cannot be its own parent or a descendant's child).

Change the settings of components already in the draft: a heading, a variant, a column count, a CustomHtml block's markup. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. Settings are merged: name only the ones to change, and null resets one to its default. Read the component first (helpcenter_get_template, section 'component' with its id) and the values its type accepts (helpcenter_get_template_guide, topic 'components'). In a synced region (header and footer usually are) the change reaches every page, and one whose pages differ is refused until you choose with helpcenter_sync_template_region. Where an unsynced region holds the same id on several pages, name the page. This is the guide's `update_component` operation. Args: - components (array, 1-50): {id, config, page?}. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Change one custom CSS block: replace its CSS, rename it, switch it on or off, or move it in the order. Fields left out keep their value. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. Read the block first (helpcenter_get_template, section 'custom_css' with its id). Switching a block off (enabled:false) shows the design without it and keeps it to switch back on. A theme's blocks are the customer's too, edited in the dashboard (Advanced → Custom CSS): to change how a theme looks, prefer a block of your own (helpcenter_add_template_css), which comes later and wins. This is the guide's `update_css` operation. Args: - id (string): the block. - css, label, enabled, index (optional): what to change. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Style one region's wrapper on one page: its background, padding, bottom border and alignment. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. config takes background (hex, or 'var(--hc-color-primary)' to follow the theme), padding (compact | standard | tall), borderBottom (boolean) and align (left | center); null resets one, and keys left out keep their value. Themes ship custom CSS that can paint a region itself (Compass paints the header and hero), and that CSS outranks this setting: when the outline marks the region "laid out by custom CSS", restyle it with helpcenter_add_template_css instead. This is the guide's `update_region` operation. Args: - page, region: which region. - config (object): the styling keys to change. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Change one script: its code (sending src, inlineBody or htmlBody switches it to that kind), position, pages, label or loading flags — or switch it off (enabled:false) without deleting it. Fields left out keep their value. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. Once published, the script runs for every visitor: change its code only as the customer asked, from a source they trust. This is the guide's `update_script` operation. Args: - id (string): the script. - position, src | inlineBody | htmlBody, label, pages, enabled, defer, async, integrity, index (optional): what to change. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.

Change document-level design settings in the draft: theme colours (light and dark), fonts, corner radius and density; the brand (name, logo, favicon); meta and SEO; and per-page settings such as a page's layout or how a category page lists its articles. It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template. Each entry is a path and its new value — 'theme.colors.primary' → '#635bff' — or a whole group at once: 'theme.colors' → {primary, accent, …}. The paths and the values each accepts are in helpcenter_get_template_guide (topic 'settings'); anything else is refused with the list of what is accepted. Colours take hex, rgb() or hsl() (stored as hex); set theme.darkColors alongside theme.colors so dark mode stays readable. An image setting (brand.logoAssetId, brand.faviconAssetId) takes {source_url: 'https://…'}: the image is copied onto this help center. Region styling has its own tool (helpcenter_update_template_region). This is the guide's `set` operation. Args: - settings (array, 1-50): {path, value}; null clears a nullable setting. - etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since. Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.