Skip to main content
The Help Center API lets you manage the customer-facing knowledge base you author in OpenCX from your own systems. Anything you can do in the Help Center editor you can do here: create and edit articles and categories, publish and unpublish them, manage translations, upload media, and push an entire content tree in one call. Publishing an article’s primary language ships it to your public help site and the AI’s knowledge in the same action. There is no separate “train the AI” step. Other languages publish to the site only; the AI always follows the primary language.

​
Scopes

Create an API key with these scopes under Settings → API keys. See Authentication.

​
Key concepts

  • Help center id — every endpoint is scoped to one help center. Call List help centers first to find the id.
  • Categories — every article belongs to exactly one category. Categories can be nested; parent_id is null for top-level ones.
  • Draft and published — creating or updating an article writes a draft version. Nothing is visible to customers or the AI until you call Publish. Editing a published article creates a new draft; publishing it supersedes the live version and keeps the old one in version history.
  • Locales — each enabled language has its own published state. Publish releases every locale at once; Publish one locale lets you ship the primary language before translations are reviewed. Only the primary language feeds the AI: publishing a translation while the primary language is still a draft makes that translation public without adding the article to the AI’s knowledge.
  • Unpublish vs delete — Unpublish takes an article offline while keeping its content and history; unpublishing the primary language also removes it from the AI’s knowledge. Delete is permanent.

​
Two ways to sync

Use the article and category endpoints when you push individual changes as they happen, for example from a CMS webhook. You control ids, drafts, and when each article goes live.
Articles are either draft or published. There is no separate internal-only visibility today: an article published in its primary language is on the public site and in the AI’s knowledge together. For content the AI should know but customers should not browse, use the AI Training API instead.

​
Available Endpoints

​
Help centers

List help centers

Find the help center id

Export content

Dump published categories and articles as a tree

Sync content

Replace the whole content tree atomically

​
Articles

List

All articles for a language

Get

One article with its versions

Create

New draft under a category

Update

New draft version

Publish

Go live in every locale

Publish one locale

Go live in one language

Unpublish

Take offline, keep content

Delete

Remove permanently

Versions

Version history

Retranslate

One language or all

​
Categories

List

All categories for a language

Get

One category with locales

Create

Top-level or nested

Update

Rename, re-icon, or move

Delete

Empty only, unless forced

Retranslate

One language or all

​
Media and API playground

Upload media

Images for article markdown

List media

Library contents and URLs

Delete media

Remove a file

Upload spec

Power the public API playground

Get spec

Read the attached spec

​
Best practices

  • Create as draft, review, then publish. Drafts never reach customers or the AI.
  • Prefer Sync content over hundreds of per-article calls when you regenerate the whole help center.
  • Set a stable slug on create when you need permanent URLs; otherwise it is derived from the title.
  • Upload images through Upload media and reference the returned URL in content_markdown.
  • Unpublish rather than delete when content might come back.