AgentStack Docs

REST API: Help Center

Manage a Help Center site, its collections, articles, and redirects.

A Help Center site is a public, multi-article knowledge base for an agent. An agent has at most one site: create it with POST /agents/{id}/help-center/site, then look it up by agent with GET /agents/{id}/help-center/site or by its own identifier with GET /help-center/sites/{siteId} once you have that identifier. Site-level updates split into two endpoints: PATCH /help-center/sites/{siteId} for content settings, and PATCH /help-center/sites/{siteId}/access for whether the site is published and who can reach it. Keep these two kinds of change separate in your integration, since a content edit should not silently affect visibility.

Collections group articles. Create a collection, then create articles inside it. An article always starts as a draft from POST .../articles. Publishing is a separate, explicit step: call the publish action to make a draft public, unpublish to pull a published article back to draft, archive to retire a published article without deleting it, and unarchive to restore an archived article to published. Do not treat a successful create as equivalent to a live, public article — check its status, and call the matching lifecycle action to change it.

Redirects map an old or external path to a current article, collection, or URL inside the site, so you can move content without breaking inbound links. Create and list them per site; delete a redirect once the path it covers is no longer needed.

GET /help-center/sites/{siteId}/insights returns search, feedback, and AI-cost metrics for the site. Use it for reporting; it does not accept writes.

Deleting a site, a collection, or an article is destructive and removes public access immediately. Confirm nothing outside AgentStack still links to the content before you delete it, and prefer archiving an article over deleting it when you might need it again.