Get Help Center Design Guide
helpcenter_get_template_guideLearn what can be customized in a help center's design and exactly how: the model, every edit operation with an example, every component with the settings and values it accepts, theme tokens, custom CSS rules and hooks, scripts and navigation.
A help center's design is its v2 template: theme tokens (colours for light and dark mode, fonts, radius, density), six page kinds (home, category, article, search, contact, notFound), each built from six regions (header, hero, sidebar, main, footer, utility) holding ordered components, plus a global navigation menu, custom CSS and scripts. You edit a DRAFT — the same draft the dashboard's Template Editor opens, with a live preview — and nothing reaches visitors until helpcenter_publish_template. Only v2 help centers can be edited: a classic (v1) one answers template_migration_required, and migrating is the owner's decision, made in the dashboard.
Call this with topic 'overview' before your first design edit in a conversation, and with topic 'components' + component_types before adding or configuring a component — the accepted values are exactly the ones the Template Editor offers, and a guess that is off by a word is refused. Generated from the live component registry, so it is always current.
Args:
topic: 'overview' (default) | 'components' | 'settings' | 'theme' | 'css' | 'scripts' | 'navigation'.
component_types (string[], for 'components'): up to 8, e.g. ['Hero', 'CategoryGrid'].
Returns: markdown; the structured guide in structuredContent. The overview also lists this help center's languages, FAQ sections (for the Faqs component) and uploaded fonts.
Errors: 409 template_migration_required for a classic (v1) help center; 403 when the connection lacks design access.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | 'overview' (start here: workflow, model, every operation, the component index, this help center's context), 'components' (full settings of chosen types), 'settings' (brand, theme, meta and page settings `set` accepts), 'theme', 'css', 'scripts' or 'navigation'. | overview |
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| component_types | No | For topic 'components': the types to describe in full, e.g. ['Hero', 'CategoryGrid']. |