The zeroheight API lets you read your design system documentation from other tools, and now write to it as well. Use it to automate your design system workflow, build your own integrations, or keep zeroheight in step with the systems your team already uses.

What can I do with the zeroheight API?

Read your documentation

• Get the content of any page as structured data, Markdown or HTML, and search across a styleguide
• List styleguides, their navigation tree, categories, releases and page statuses
• Pull the activity feed of page edits, status changes and releases
• Export design tokens from your token sets in the format your pipeline needs
• List the component sets, design libraries, page templates, connected repositories and Storybooks a styleguide uses

Write to your documentation

• Create new pages and edit existing ones, from a quick find-and-replace to replacing a whole page
• Rename, hide, move and reorder pages
• Create, rename and reorder navigations and categories
• Upload images and files to use in page content
• Review the changes in a page draft and publish it
• Update page statuses, for example to keep them in sync with a project management tool

Writing to zeroheight with the Editor API

Until November 2026 the only way to create or edit page content from outside zeroheight was through the zeroheight MCP, which needs an AI tool in the loop. The Editor API opens the same capability to anything that can make an HTTP request: a build pipeline, a script, an internal tool or an agent you've built yourself.

Some things teams use it for:

• Generating component documentation from code or Storybook as part of a build, instead of copying it across by hand
• Migrating content from another tool, or keeping a page in sync with a source of truth that lives elsewhere
• Filing documentation changes from an in-house agent or workflow tool

Drafts and publishing

On plans with draft pages, edits made through the API are saved to the page's draft by default, so an editor can review them in zeroheight before they go live. An integration can ask to publish directly instead. New pages are published straight away unless the integration asks for a draft. On plans without drafts, changes are published immediately.

What you need

• A plan that includes the API (Professional or Enterprise)
• Write access switched on for your organization under Your organization → Model Context Protocol (MCP). It's on by default, and the same setting controls MCP write
• An authentication token created with the Editor API use case. A token acts as the person who created it, so they need to be an editor or admin on the styleguide being written to

Page content is sent as editor XML, the same format the MCP uses. The API documentation describes every block, and the editor instructions endpoint returns the full format for an agent or script to follow.

How does it work?

The API follows a REST structure, so each resource (pages, styleguides, tokens, structure) has its own address and the HTTP method says what you want to do: GET to read a page, POST to create one, PATCH to edit it.

Every token can make 30 read requests and 30 write requests every 30 seconds. Going over returns a 429 response that says when to retry.

Authentication tokens

Every request needs a token. Tokens belong to your team, carry only the scopes you give them, and can be revoked at any time. Read more about creating authentication tokens and choosing a use case.

API docs

Full API documentation is available at developers.zeroheight.com. The release notes list what's been added in each version.