> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.
# Help Center API
> Create, update, publish, and delete help center articles and categories from your own systems, and manage the site itself — languages, glossary, branding, and ordering.
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](/help-center/overview) editor you can do here: create and edit articles and categories, publish and unpublish them, manage translations and the glossary, order the tree, upload media, and change the site's own settings.
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
| Scope | Grants |
| - | - |
| `help-center-content:read` | List and fetch articles, categories, versions, the content tree, and media |
| `help-center-content:write` | Create, update, publish, unpublish, move, reorder, restore, delete, retranslate, upload |
| `help-center:read` | List and fetch help centers, their language settings, and their glossary |
| `help-center:write` | Change a help center's settings, served languages, and glossary |
`help-center:read` and `help-center:write` also grant the matching content scope, so an existing key keeps working unchanged. Create an API key under **Settings → API keys**. See [Authentication](/api-reference/authentication).
## Key concepts
* **Help center id** — every endpoint is scoped to one help center. Call [List help centers](./list) 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.
* **Source language** — each article records the language it was written in. Every other language is a translation of it. Pass `language_code` on [Create](./articles/create) when the article is authored in something other than the help center's primary language; it cannot be changed later.
* **Draft and published** — creating or updating an article writes a new **version**. Nothing is visible to customers or the AI until you call [Publish](./articles/publish), which ships the newest stored version. [Language states](./articles/language_states) tells you, per language, what is live and what is waiting.
* **Locales** — each enabled language has its own published state. [Publish](./articles/publish) releases every locale at once; [Publish one locale](./articles/publish_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 unpublished makes that translation public without adding the article to the AI's knowledge.
* **Per-language structure** — where an article or category sits, and in what order, is recorded per language. A [move](./structure/move_article) changes one language's tree and leaves the others alone.
* **Unpublish, delete, restore** — [Unpublish](./articles/unpublish) takes an article offline while keeping its content and history; unpublishing the primary language also removes it from the AI's knowledge. [Delete](./articles/delete) is reversible through [Restore](./articles/restore) while the article is still soft-deleted.
Articles are either unpublished 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](/api-reference/training/index) instead.
## Available Endpoints
### Help centers
Find the help center id
Settings, branding, and custom code
Name, domain, CSS, head scripts
### Languages and glossary
Served languages and auto-translate
Change what is served
What is still translating
Terms the translator keeps
Protect a product name
Change a term or definition
Remove a term
Copy the organization glossary
### Articles
All articles for a language
One article with its versions
New article under a category
New stored version
Go live in every locale
Go live in one language
What is live, what is waiting
Take offline, keep content
Remove from the tree
Bring a deleted article back
Version history
One language or all
### Categories
All categories for a language
One category with locales
Top-level or nested
Rename or re-icon, per language
With or without its contents
Bring a deleted category back
One language or all
### Structure
One language, whole tree, in order
Into a category, at a position
Nest it or lift it to the top
Order one category's children
### Media
Images for article HTML
Library contents and URLs
Remove a file
## Best practices
* Create, review, then publish. An unpublished article never reaches customers or the AI.
* Article bodies are HTML fragments in `content_html`, on reads and writes. It replaces the former `content_markdown` field, which is no longer accepted.
* Read the article before you update it and send the whole `content_html` back — an update replaces the body rather than patching it.
* Read [Language states](./articles/language_states) before publishing so you know which locales the call will change.
* `enabled_languages` and `localizations` **replace** what is stored rather than merging. Read the current value first and send it back whole.
* Set a stable `slug` on create when you need permanent URLs; otherwise it is derived from the title.
* Upload images through [Upload media](./media/upload) and reference the returned URL in `content_html`.
* Embed a video with ``. `data-embed` is `youtube`, `vimeo`, `loom` or `wistia`; `data-embed-id` is the video's id from its link — for an unlisted Vimeo video, `76979871/8272103f6e`. An embed with another host or a malformed id is removed on save, and `