Skip to main content

​
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

MethodPathPurpose
POST/api/v1/publishPublish HTML (create or new version). Returns document_id, version_id, share_url.
GET/api/v1/documentsList documents in the workspace.
GET/api/v1/documents/:idDocument metadata + versions. Query ?include_html=true for full HTML.
PATCH/api/v1/documents/:idUpdate title and/or description only.
DELETE/api/v1/documents/:idDelete document permanently (204).
MCP tools map to these routes: publish_document, get_document, update_document, delete_document.

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

FieldTypeRequiredDescription
titlestringYes1–500 characters
htmlstringYesFull HTML, up to 5,000,000 characters
document_iduuidNoAppend a version to an existing document
notestringNoVersion 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.

MCP overview

publish_document