article-management

Article Management

Manage articles in the user's PlumAI account.

List Articles

GET /v1/articles

Query parameters:

Param	Type	Default	Description
limit	number	20	Results per page (max 100)
cursor	string	—	Cursor for next page
status	string	—	Filter: draft, review, published, archived
language	string	—	Filter by language code (e.g. en, es)
category	string	—	Filter by category
sortBy	string	createdAt	Sort field

Response:

{
  "articles": [...],
  "pagination": {
    "cursor": "next_cursor_value",
    "hasMore": true
  }
}

Pagination: Use cursor-based pagination. If hasMore is true, pass the returned cursor value as query param to get the next page.

Get Article by ID

GET /v1/articles/:id

Returns full article content including sections, FAQ, SEO data, and images.

Get Article by Slug

GET /v1/articles/slug/:slug

Look up an article by its URL slug.

Update Article Status

PATCH /v1/articles/:id/status

Body:

{
  "status": "published"
}

Valid statuses: draft, review, published, archived

Article Statistics

GET /v1/articles/stats

Returns counts by status, language, and top categories.

Response:

{
  "total": 42,
  "byStatus": { "draft": 10, "published": 30, "review": 2 },
  "byLanguage": { "en": 25, "es": 10, "fr": 7 },
  "topCategories": [{ "name": "Marketing", "count": 15 }]
}

Workflows

Browse all published articles

1. GET /v1/articles?status=published&limit=50
2. If hasMore, repeat with cursor

Find article in a specific language

1. GET /v1/articles?language=es&limit=20

Publish a draft

1. PATCH /v1/articles/:id/status with { "status": "published" }