archive_article
ChatGPTTake an article off the help center without deleting it. An archived article keeps its category, disappears from the help center and from search, and accepts no edits until it is unarchived. Use this instead of deleting when the content should be kept but should not be read. Archiving a live article requires publish permission.
create_article
ChatGPTCreate a new help documentation article. Returns the new article's identity, placement and state (id, title, slug, url, status, category, tags, version) — not its body. Call fetch if you need the stored content back. Full field reference: https://apidocs.helpdocs.io/article/8Y2t6NVxeU-creating-an-article
create_category
ChatGPTCreate a new category for grouping articles. It is added to the knowledge base immediately. Calling it twice creates two categories.
create_redirect
ChatGPTAdd a redirect rule, e.g. to keep an old article link working after a slug change or a merge. It is added LAST in match order, so an earlier rule that also matches still wins; use reorder_redirects to move it. A rule that would send visitors round in a loop is refused. Takes effect immediately for every visitor, so only add a rule a human has asked for, and confirm with them before adding a wildcard. Only redirects within the help center can be made here.
delete_article
ChatGPTDelete an article. This is a soft delete and can be undone with restore_article, so no confirmation step is required — but it does remove the article from the knowledge base immediately, so check with the human first if there is any doubt about which article was meant.
delete_category
ChatGPTDelete an empty category. This is permanent — unlike articles, a deleted category cannot be restored. A category that still contains articles or sub-categories cannot be deleted; move or delete its contents first. Call it first WITHOUT confirm_token: nothing is deleted, and the response describes exactly what would be. Relay that impact to the human, and only call again with the returned confirm_token once they have agreed.
delete_redirect
ChatGPTDelete one redirect rule. Visitors to its from path get a 404 again straight away. The response returns the deleted rule, so it can be put back with create_redirect, though it is then last in match order.
fetch
ChatGPTFetch the full content of a specific article by ID. Returns what is currently live. The response's metadata.language_code says which language the text is in, and metadata.available_languages lists the languages this article has been translated into. Callers with content management permission also get metadata.has_working_copy, saying whether an unpublished working copy is waiting on top of the live version IN THAT LANGUAGE, and can read it with working_copy: true.
get_analytics
ChatGPTGet analytics for the knowledge base. All metrics exclude bot traffic except ai_bots, which is only bot traffic. If the question is "what should we write or fix next", start with content_gaps and feedback.
get_category
ChatGPTGet full details of a specific category by ID. Read-only.
get_clip
ChatGPTRead one Clip: its content as HTML, how many articles embed it (used_in_articles), and how many of those are live (live_articles). Changing a Clip changes all of them at once.
get_variable
ChatGPTRead one variable: its value, how many articles use it directly or through a Clip (used_in_articles), and how many of those are live (live_articles). Changing a variable changes all of them at once.
list_archived_articles
ChatGPTList archived articles. They are deliberately absent from list_articles and from search, so this is the only way to find one without already knowing its ID. Only articles the caller could have archived are shown.
list_articles
ChatGPTList and filter articles in the knowledge base. Returns one page at a time: when the response carries next_cursor, pass it back as the cursor argument (with every other argument unchanged) to fetch the following page, and keep going until next_cursor is absent. A page can come back with fewer articles than the limit — or none at all — while has_more is still true, because articles the caller cannot see are removed after the page is read; that is not the end of the list, so keep paging until next_cursor is gone.
list_categories
ChatGPTList all categories in the knowledge base. Read-only. Use it to find a category_id for the article and category tools.
list_clips
ChatGPTList the knowledge base's Clips: reusable blocks of content that articles embed, so one edit to a Clip changes every article that uses it. Each has a clip_id, title, and whether it is private (yours only), locked, or a template. An article embeds one as an element with data-clip-id="<clip_id>". Call get_clip for its content and where it is used. Read-only: there is no tool to change a Clip, so suggest any change to the human to make in HelpDocs.
list_deleted_articles
ChatGPTList soft-deleted articles that can still be restored with restore_article. Only articles the caller could have deleted are shown.
list_permission_groups
ChatGPTList permission groups (user groups) on this account. Returns {user_groups: [{permission_group_id, group_id, name, user_is_member, user_read_only_member}], can_assign_any}. Pass the permission_group_id value (already in the required "group:<id>" form) directly to the permission_groups parameter of create_article, update_article, create_category, or update_category. When can_assign_any is true (caller has settings:edit) any group can be assigned. When false, only groups where user_is_member=true will be accepted; user_read_only_member=true means the caller can view content restricted to that group but cannot assign it, so those are still rejected on write.
list_redirects
ChatGPTList the help center's redirect rules in match order. The first rule that matches wins, and rules only run for a path that would otherwise be a 404. Each rule has a redirect_id, from, to and status_code (301 permanent, 302 temporary).
list_variables
ChatGPTList the knowledge base's variables: short values, such as a product name, that articles and Clips show wherever they hold an element with data-var-id="<variable_id>". Each has a variable_id, title, value, and whether it is locked. Call get_variable for where one is used. Read-only: suggest any change to the human to make in HelpDocs.
publish_working_copy
ChatGPTPublish an article's unpublished working copy, so the help center serves those pending edits instead of what it serves now, exactly as the Publish button in the editor does. Nothing else about the article changes. This is how a change written with update_article(working_copy: true) goes live, and it publishes the working copy AS IT STANDS, so read it with fetch(working_copy: true) first if you did not write it yourself. Fails if the article has no working copy in the language being published. Each language is published separately: publishing one leaves working copies in every other language untouched.
reorder_redirects
ChatGPTSet the match order of the redirect rules. The first rule that matches wins, so order matters when rules overlap (a wildcard before a specific path hides the specific one). Pass EVERY redirect_id from list_redirects, in the new order: a list that is missing a rule, has one twice, or names one that no longer exists is refused and nothing moves, so call list_redirects again and retry.
restore_article
ChatGPTRestore an article that was deleted. Deletes are soft, so anything deleted (whether by this agent or by someone in the editor) can be brought back until it is purged. Use list_deleted_articles to find the ID if you do not already have it.
search
ChatGPTSearch for articles in the knowledge base using typeahead-style search. Short, specific queries work best (1-3 words). Use exact phrases rather than full questions. Each result carries a status field, so a result can be told apart from a published one at a glance.
unarchive_article
ChatGPTBring an archived article back as a DRAFT, in the category it was archived from. It does not return to the status it had before archiving, so an article that was published is not republished by this: publish it with update_article if it should go back on the help center.
update_article
ChatGPTUpdate an existing article. Only the fields you send are changed. Edits to a PUBLISHED article go live immediately: pass working_copy: true to save them as an unpublished working copy instead, which is what a human usually means by "draft this". Returns the article's identity, placement and state (id, title, slug, url, status, category, tags, version) — not its body. Call fetch if you need the stored content back. Full field reference: https://apidocs.helpdocs.io/article/sc5pREDFNn-updating-an-article
update_category
ChatGPTUpdate an existing category: rename it, change its slug or description, or move it under another parent. Only the fields you send are changed, and the change is live on the help center immediately. Changing the slug changes the category's public URL.
update_redirect
ChatGPTChange one redirect rule. Only the fields you send change; the rest are left as they are. Takes effect immediately.
create_article
Claudecreate_category
Claudedelete_article
Claudedelete_category
Claudefetch
Claudeget_analytics
Claudeget_category
Claudelist_articles
Claudelist_categories
Claudelist_deleted_articles
Claudelist_permission_groups
Claudepublish_working_copy
Clauderestore_article
Claudesearch
Claudeupdate_article
Claudeupdate_category
Claude