Get Help Center Status
helpcenter_get_help_centerRead the status of the help center you created: whether the user has claimed it, when it is deleted, how full it is, a fresh preview link, and what is left to set up.
Call it after writing content, before giving the user the claim link, and whenever a tool answers capability_locked.
Returns (also as structuredContent): claimed; claim {state: open | held | claimed, held_until}; expires_at (null once claimed, and while a migration request holds it); counts and limits {articles, categories, languages}; claim_url (while unclaimed); preview_url; next_step {code, instruction, url}, also under setup; setup {claimed, email_verified, plan_activated}; capabilities {content, design, redirects, custom_domain}: what agent_key may do now.
preview_url: shows the help center as its readers will see it, page to page, for one hour (published articles only). A new link on every call. Open it to check your work, or give it to the user to look before they claim.
next_step: pass its instruction on to the user as it is. not_claimed: give the user claim_url. wait_for_migration: a migration request is moving content; follow it with helpcenter_get_migration_request. email_unverified, plan_not_activated, make_public: the user's steps in their dashboard after the claim. You cannot make a help center public: only the user can.
capabilities: redirects and custom_domain unlock only once the user has claimed the help center, verified their email address and activated a plan.
Args:
site_id (number, required): as helpcenter_create_help_center returned it.
response_format ('markdown' | 'json'): default 'markdown'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | The site_id helpcenter_create_help_center returned for this help center. | |
| 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. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |