Get HelpCenter Article
helpcenter_get_articleRead one article by id from the connected HelpCenter.io help center.
Use this when you already know the id — after a search, or before editing — instead of paging through helpcenter_list_articles to find it again. Read-only.
Also the way to check whether an article has unpublished staged edits waiting on it: the response carries has_staged_changes, staged_locales and staged_updated_at. Check that before a live update, or your edit and somebody else's staged work will collide.
Args:
article_id (number, required): id of the article.
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { status: "success", article: {...} } — the full article, including per-language title/content/slug, categories, external_id, and the staged-changes flags.
Errors: 404 if the id is unknown OR belongs to another help center — the endpoint deliberately does not distinguish the two, so a 404 is not proof the article does not exist somewhere else.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| article_id | Yes | Id of the article to read. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |