Use this section when you already know the article content you want to store or update directly. For source-backed generation, start from Knowledge and the generation routes there.
Reference pages
List articles
GET /v2/hc-articles/public — list live articles, draft articles, or both.Get articles by IDs
POST /v2/hc-articles/ids/public — fetch one or more articles by ID.Create article
POST /v2/hc-articles/public — create a live article or draft article.Update article
PUT /v2/hc-articles/:id/public — update an existing article.Create article draft
POST /v2/hc-articles/:id/draft/public — create a draft from an existing article.Publish article draft
POST /v2/hc-articles/:id/publish/public — publish a draft article.Delete article
DELETE /v2/hc-articles/:id/public — delete an article.Endpoint map
| Method | Path | Scope | Purpose |
|---|---|---|---|
GET | /v2/hc-articles/public | read | List articles. Use type=live or type=draft to filter. |
POST | /v2/hc-articles/ids/public | read | Fetch one or more articles by ID. |
POST | /v2/hc-articles/public | write | Create a live article or draft article. |
PUT | /v2/hc-articles/:id/public | write | Update an existing article. |
POST | /v2/hc-articles/:id/draft/public | write | Create a draft from an existing article. |
POST | /v2/hc-articles/:id/publish/public | write | Publish a draft article. |
DELETE | /v2/hc-articles/:id/public | write | Delete an article. |
There is no workspace-API-key
GET /v2/hc-articles/:id/public route in the current controller. If you want to fetch by ID, use POST /v2/hc-articles/ids/public with one or more articleIds.Article object
Article ID.
Article title.
Main knowledge body.
Additional instructions the agent should apply when using this article.
Question prompts associated with the article.
Keyword list associated with the article.
Whether the article is marked as escalation-related.
Internal metadata stored with the article. Source-backed generation and draft flows may use this to retain linkage data.
Whether the article is active.
Whether the article is public in the help center.
Folder that contains the article.
Workspace ID that owns the article.
ISO 8601 creation timestamp.
ISO 8601 last-update timestamp.
Article version, when versioning metadata is available.
Whether the draft has already been published, when applicable.
Original live article ID when this object is a draft of an existing article.
Version of the original live article when this draft was created.
User ID that created the article, when stored.
Origin marker for the article, when one was stored.
Use the child pages in this section for the detailed request and response reference for each route.