Create an article

Creates an article as an open draft. The article is not live until you publish it.

POST /v1/articles

Bearer token scope content:write

curl 'https://api.ferndesk.com/v1/articles' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Getting started with API keys",
  "content": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "markdown": "# Getting started\n\nWelcome to the API.",
  "publish": false,
  "sectionId": "sect_01JXYA4T1JNT",
  "collectionId": "col_01JXYA6ABN52",
  "keywords": "api, auth, keys",
  "metaDescription": "Learn how to create and rotate Ferndesk API keys.",
  "ogImage": "https://cdn.ferndesk.com/og/getting-started.png",
  "slug": "getting-started-api-keys"
}'

{
  "id": "art_01JXY9AZK4KV",
  "title": "Getting started with API keys",
  "slug": "getting-started-api-keys",
  "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
  "contentMarkdown": "# Welcome to the Ferndesk API",
  "contentJson": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
  "sectionId": "sect_01JXYA4T1JNT",
  "collectionId": "col_01JXYA6ABN52",
  "status": "published",
  "layout": "default",
  "publishedAt": "2026-01-15T18:25:43.511Z",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "draft_id": "drft_01JXY9AZK4KV"
}

Created article

Body

required application/json

title string · min length: 1 required

Article title.

content any

Body as a Tiptap document; not accepted alongside markdown.

markdown string

Body as Markdown, converted to rich text on write; not accepted alongside content.

publish boolean · default: false

Publishes the new article in the same call instead of leaving an open draft.

sectionId string · min length: 1 required

Section to create the article in.

collectionId string | null

Collection to group the article under.

keywords string

Comma-separated SEO keywords.

metaDescription string

SEO meta description.

Body

Responses