API

API

The delivery, management, site and agent APIs, the rich text and image formats they share, and the errors they answer with.

1 min read

Content has one API per job, and they share a token model: a delivery token reads published content, a preview token reads drafts, a management token changes the model and content, and a site token acts as an editor on their own site. Every token belongs to one space and one environment.

APIUse it for
DeliveryRead a site's content with a delivery or preview token: pages by path, entries, locales, depth.
ManagementRead, plan and apply the content model, and write content with a content-scoped token. The CLI and model-in-Git use it.
SiteWhat a site's server calls with an editor's site token, when editing on the site. The SDK's /cms handler forwards to it.
Agent API and MCPEverything the dashboard does, over HTTP or as MCP tools, for agents.
Rich textThe document format rich text fields deliver, including embedded entries and assets, and Markdown.
ImagesResized, re-encoded copies of an image asset with a query on its URL.
ErrorsEvery error code, in RFC 9457 problem JSON.

Start with API tokens for which token to create, and the JavaScript SDK for the client that sends them.

On this page

No Headings

Marks in the margin

  • Note
  • Watch out
  • Updated

Scribes marked doubtful lines in the margin. That practice is called obelism.

Stuck on a step?