REST API (v1)

Most teams publish through the dashboard or MCP tools. The REST API is available when you need scripts, CI, or a non-MCP integration.

Base URL: https://unfurl.pub
Auth: Create a key at Dashboard → API keys, then send X-Api-Key: oodoc_… or Authorization: Bearer oodoc_… on every request.

Endpoints

Method	Path	Purpose
`POST`	`/api/v1/publish`	Publish HTML (create or new version). Returns `document_id`, `version_id`, `share_url`.
`GET`	`/api/v1/documents`	List documents in the workspace.
`GET`	`/api/v1/documents/:id`	Document metadata + versions. Query `?include_html=true` for full HTML.
`PATCH`	`/api/v1/documents/:id`	Update `title` and/or `description` only.
`DELETE`	`/api/v1/documents/:id`	Delete document permanently (`204`).

MCP tools map to these routes: publish_document, get_document, update_document, delete_document.

Publish body (`POST /api/v1/publish`)

Field	Type	Required	Description
`title`	string	Yes	1–500 characters
`html`	string	Yes	Full HTML, up to 5,000,000 characters
`document_id`	uuid	No	Append a version to an existing document
`note`	string	No	Version note, up to 2000 characters

Success (200):

{
  "document_id": "…",
  "version_id": "…",
  "share_url": "https://unfurl.pub/d/…"
}

Plan limits

Free workspaces are limited to 5 published documents and 1 API key. Pro removes those caps and unlocks password-protected links, in-dashboard editing, and custom branding. See pricing.

​REST API (v1)

​Endpoints

​Publish body (POST /api/v1/publish)

​Plan limits

MCP overview

publish_document

REST API (v1)

Endpoints

Publish body (`POST /api/v1/publish`)

Plan limits