AgentStack Docs

REST API: Help Page

Read and update an agent's standalone Help Page configuration.

The Help Page is the standalone branded chat page served at /help/[agentPublicId], configured per agent. Use GET /agents/{id}/help-page to fetch its current configuration, including branding, theme, and suggested messages. Use PATCH /agents/{id}/help-page to update it.

Fetch the current configuration before you update it. A PATCH request should carry only the fields you intend to change alongside the values you want to keep, since sending an incomplete picture of unrelated fields risks reverting a setting another team member configured from the dashboard.

The Help Page is a single, focused surface: one branded chat experience per agent, distinct from a Help Center site's multi-article knowledge base (see REST API: Help Center). Enabling or disabling the channel itself, and any DNS-level custom domain routing to it, are handled by the channels and custom-domains endpoints, not by this configuration resource.

Treat branding fields such as logo and favicon URLs as pointing at assets you already host or have uploaded through the appropriate source endpoints. This endpoint stores configuration; it does not accept raw image uploads.