Create an article

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS create article API allows you to create a new article in your knowledge base.

POST https://api.featureos.app/api/v3/articles

curl -X POST 'https://api.featureos.app/api/v3/articles' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/articles', {
  method: 'POST',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.featureos.app/api/v3/articles',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.
Authorization	-	Generate a unique JWT token specific to a user.

Body Parameters

Parameter	Required	Format	Description
title	true	String	The title of the article. Also used to generate the slug.
description	false	Text	The content of the article. HTML is allowed.
collection_id	true	Integer	The ID of the collection this article belongs to.
status	false	String	The article status: `draft` or `published`. Defaults to `draft`.
privacy	false	String	The article privacy: `public`, `unlisted`, or `private`. Defaults to `public`.
locale	false	String	Language code for the article (e.g., `en`, `es`, `fr`). Defaults to the organization's default language.
seo_title	false	String	Custom SEO title for the article.
seo_description	false	String	Custom SEO meta description.
cover_image	false	File	Cover image for the article. Accepts `jpeg`, `jpg`, `png`, or `gif`. Max 10 MB.
tag_ids	false	Array	IDs of tags to attach to the article.
assignee_ids	false	Array	IDs of team members to assign to the article.

Sample response

{
  "id": 42,
  "title": "Getting Started with SSO",
  "slug": "getting-started-with-sso",
  "status": "draft",
  "key": "FO-112",
  "updated_at": "2025-01-15T08:30:00.000Z",
  "description": "<p>Learn how to set up Single Sign-On for your organization.</p>",
  "cover_image": null,
  "locale": "en",
  "privacy": "public",
  "imported_resource": null,
  "imported_resource_id": "0",
  "position": 1,
  "seo_title": null,
  "seo_description": null,
  "authors": [
      {
        "id": 1234,
        "name": "Swathy",
        "email": "[email protected]"
      }
  ],
  "assignees": [],
  "tags": [],
  "published_at": null,
  "collection": {
      "id": 5,
      "slug": "getting-started",
      "color": "default",
      "description": "Everything you need to get started.",
      "icon": null,
      "kind": "category",
      "name": "Getting Started",
      "published_articles_count": 8,
      "published_articles_count_with_children": 0,
      "read_only": false,
      "sub_categories_count": 0,
      "created_at": "2024-05-20T05:44:33.911Z",
      "updated_at": "2025-01-15T08:30:00.000Z",
      "parent_id": null,
      "user_id": 123,
      "privacy": "public",
      "position": 1,
      "seo_title": null,
      "seo_description": null
  }
}