Integrations and API

The HelpCenter.io API

The HelpCenter.io API lets your own code and tools work with your help center. Keep articles in sync with your product docs or a Git repository, import content in bulk, publish a release's changes together, answer reader comments and pull your statistics into your own reports. It's a REST API at https://api.helpcenter.io/v1 that sends and receives JSON.

Who can create keys: Owners and Admins · Plans: All plans

Get started

  1. Create an API key in Settings → API keys. See Create an API key.

  2. Give the key to whoever builds the integration. Keys belong on your servers: never in a web page, an app's front end or a public repository.

  3. Make a first request with Quickstart: your first API request on the developer portal.

The API is included in every plan. A few endpoints act on features of a particular plan, such as staged changes on Catalyst, and connecting AI agents needs Growth or Catalyst.

The developer portal

The developer portal, developers.helpcenter.io, documents every endpoint, field, limit and error, with code samples in several languages. The full API specification that used to be on this page lives there now.

Was this article helpful?

Recent Articles

Articles you view will appear here.

    Comments

    Be the first to comment.

    This is just a preview of the comment. It needs to be approved first in order to appear for everyone.