Manage help centers and their collections. Undocumented API.

Actions:

• list(): List all help centers.

• get(id): Get one help center with all settings and theme.

• locales(): List the locale codes a help center can use.

• tree(id, ...): Collections and articles of a help center as a tree, without content.

• insights(id): Top and zero-result search terms of the public help center.

• create(name, slug, page_title, ...): Create a help center.

• update(id, ...): Change only the given settings of a help center.

• collection_list(help_center_id): List the collections of a help center.

• collection_create(help_center_id, name, ...): Create a collection in a help center.

• collection_update(help_center_id, id, ...): Change only the given fields of a collection.

• collection_reorder(help_center_id, order): Sort many collections at once.

Manage knowledge base articles, written and read as markdown. Undocumented API.

Actions:

• list(help_center_id, ...): List a help center's articles, without content.

• visibility(help_center_id, ...): Which articles AI assistants can use, and why the others are hidden.

• get(id, ...): Get one article with content and translations.

• create(collection_id, title, content, ...): Create a draft article in a collection.

• update(id, ...): Change only the given fields of an article.

• sync(path, ...): Create or update draft articles from local .md files with frontmatter; writes new ids back. Never publishes.

• move(id, collection_id): Move an article to another collection of its help center.

• reorder(collection_id, order): Sort many articles of a collection at once.

• linkable(help_center_id, exclude_locale): List articles linkable as translation: other locale, not yet linked.

• link_translation(id, translation_of_id): Make an article a translation of another article.

• unlink_translation(id): Take an article out of its translation group.

Manage the snippets AI assistants answer from, and review FAQ suggestions. Undocumented API.

Actions:

• snippet_list(...): List the snippets AI assistants search, with a short preview.

• snippet_get(id): Get one snippet with its full content.

• snippet_create(title, content, ...): Add a snippet: a self-contained answer with a clear title.

• snippet_update(id, ...): Change only the given fields of a snippet.

• snippet_import_url(url): Import a web page's readable text as a snippet.

• faq_list(...): List FAQ suggestions mined from resolved conversations.

• faq_approve(id, ...): Approve a FAQ suggestion as an enabled snippet, optionally edited.

• faq_reject(id): Reject a FAQ suggestion without creating a snippet.

• learning_get(): Show whether FAQ learning is on.

Look up ids of agents, teams, inboxes and other settings.

Actions:

• me(): The API key's agent, with roles and permissions.

• agents(): List agents (id, name, email). [undocumented]

• teams(): List teams (id, name). [undocumented]

• tags(): List conversation tags.

• inboxes(): List inboxes with channel and enabled state.

• statuses(): List conversation statuses.

• priorities(): List conversation priorities.

• custom_attributes(...): List custom attribute definitions.

Change what customers and AI assistants see: publish articles and collections, take help centers online or offline, switch FAQ learning. Undocumented API.

Actions:

• help_center_toggle(id): Take a help center online or offline. Changes what the public sees.

• collection_publish(help_center_id, id, is_published): Publish or unpublish collections. Changes what the public help center shows.

• article_set_status(id, status): Publish articles or set them back to draft. Publishing makes the article public, and AI-usable when ai_enabled is on.

• learning_set(enabled): Switch FAQ learning on or off. When enabled is true: Mines resolved conversations with your AI provider, at a cost per conversation.

Delete help centers, collections, articles and snippets. Deletes cannot be undone. Undocumented API.

Actions:

• help_center_delete(id): Delete a help center. Deletes it with all its collections and articles.

• collection_delete(help_center_id, id): Delete a collection. Deletes it and its articles.

• article_delete(id): Delete an article. Deletes the article. Linked translations stay.

• snippet_delete(id): Delete a snippet. Assistants stop using it.

Raw API access for what other tools lack; find the endpoint with catalog first.

Actions:

• call(method, path, ...): Send one request. DESTRUCTIVE for DELETE: needs confirm.

• catalog(...): List known endpoints; with domain, also their fields.

Show the profile in use and whether its server accepts it, as which agent. Call it on auth, profile or connection errors.