Content

Send the site's pages as Markdown, and Manifest builds a documentation site from them.

Send content

If you have the content but no site, send it in one JSON request: the site's pages, written in Markdown, plus site settings and theme. Manifest builds them into a documentation site from its docs template. There is no build step on your side and no zip. Each ingest is a new deployment of the whole site, so it replaces everything the previous ingest published.

Content works on projects your keys created through the API. On your other projects it answers 422 not_api_project, so it never replaces a site you built another way; publish a zip to those instead.

In the request, each page is an entry in articles, with a title, a slug for its URL, the group it is listed under in the navigation, and its markdown.

curl -X POST https://api.manifestx.dev/v1/projects/proj_…/content \
  -H "Authorization: Bearer $MANIFEST_ACCOUNT_KEY" \
  -H "Idempotency-Key: help-center-sync-0193" \
  -H "Content-Type: application/json" \
  -d @content.json

{
  "template": "docs",
  "env": "staging",
  "site": {
    "name": "Acme Help",
    "description": "Answers for Acme customers.",
    "theme": {
      "tokens": { "color-brand-surface": "oklch(55% 0.2 260)" },
      "dark": { "color-brand-surface": "#6677ff" }
    }
  },
  "groups": [{ "slug": "start", "description": "First steps with Acme." }],
  "articles": [
    { "group": "Getting started", "group_slug": "start", "title": "Welcome", "slug": "welcome", "markdown": "Hello from Acme.", "order": 1 },
    { "group": "Billing", "title": "Invoices", "slug": "invoices", "markdown": "## Download\n\nUse the portal.", "icon": "lucide:receipt" }
  ]
}

Each entry in articles is one page:

Pages carry markdown only: a field not listed here is refused, in a page, site, site.theme, or groups, and so is markdown containing control characters. Images and other files are not part of the payload, so link to them by absolute URL.

The site answers 201 Created and is live on that environment's URL straight away:

{
  "deployment": { "id": "dep_…", "env": "staging", "status": "ready", "files": 10, "bytes": 26676 },
  "template": { "name": "docs", "version": "0.1.2" },
  "url": "https://acme-docs-staging.manifestx.ai",
  "request_id": "…"
}

Rarely, the site goes live but a follow-up step, such as setting up the default hostname, doesn't finish. The answer is still 201, with a warning:

{ "warning": { "code": "post_publish_incomplete", "message": "The site is live, but a follow-up step …" } }

The deployment is live and counts as published, so don't resend it. The step completes on the next publish, and url can be null until then.

A page is served at /docs/<group_slug>/<slug>. Promote, rollback, and the deployment list work exactly as for your own builds.

Template version

A project's first successful ingest pins the docs template version it was built with, and every later ingest uses the same version, so a template update never changes a live site unasked. The pinned version is in every response.

Slug rules

Slugs are lowercase letters and digits in words joined by single hyphens, such as payment-methods, up to 80 characters. Because the site matches a link against every part of its path:

• a page slug is unique across all groups, not only within its own;
• a page slug can't equal any group slug: a billing page inside a billing group is refused, so name it billing-overview;
• neither can be docs, the segment the site lives under;
• one group_slug has one group name, and two groups can't share a name.

Theme values

Token names are the template's theme tokens, with or without the leading --. Values can be colors, numbers, lengths, quoted font names, and these functions: rgb, rgba, hsl, hsla, hwb, lab, lch, oklab, oklch, color, color-mix, var, calc, min, max, clamp, light-dark. url(), comments, semicolons, braces, unclosed quotes or parentheses, and values over 200 characters are refused. Up to 100 tokens each for light and dark.

Content limits

Retrying an ingest

Send an Idempotency-Key with every ingest. A retry with the same key and body returns the first response and creates no second deployment; the same key with a different body is 422 idempotency_key_reused. A 5xx is never stored, so a retry after one runs again.

Errors

A content problem answers 422 with a field that names the page and property, and no deployment is created:

{
  "error": "invalid_content",
  "message": "articles[1].slug: invalid slug \"Bad Slug\".",
  "field": "articles[1].slug",
  "request_id": "…"
}