REST API

Publish and manage pages from scripts, CI and your own apps.

• Base URL: https://api.docpin.app
• Auth: Authorization: Bearer dp_…. API keys belong to one workspace and act with the rights of the owner who created them; they stop working if that person leaves the workspace. Workspace owners create keys in the DocPin app under Connections → API keys. The full key is shown once.
• Format: JSON in and out, except uploads, which can be multipart/form-data.
• Errors: a non-2xx status with { "error": "Plain-English message" }.
• Rate limits: about 30 publishes a minute per workspace, and separately about 30 data writes a minute. Over that: 429.

Pages are identified by id (a UUID) in paths. GET /v1/pages lists them, and publishing returns doc.id.

Publish a page

POST /v1/pages

Upload one HTML file, several files, or a .zip (up to 25 MB) as multipart/form-data, or send HTML as JSON.

curl https://api.docpin.app/v1/pages -H "Authorization: Bearer $DOCPIN_API_KEY" \
  -F file=@index.html -F slug=q4-report

curl https://api.docpin.app/v1/pages -H "Authorization: Bearer $DOCPIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"html": "<!doctype html><title>Hello</title><h1>Hello</h1>", "slug": "hello"}'

Response (201 for a new page, 200 for a new version):

{
  "created": true,
  "url": "https://acme.docpin.it/hello",
  "prettyUrl": "https://acme.docpin.it/hello",
  "shortUrl": "https://docpin.it/Ab3dE7",
  "doc": { "id": "61fb0253-…", "title": "Hello", "slug": "hello", "board": null, "unlisted": false, "access": { "kind": "public" } },
  "version": { "id": "…", "files": 1, "bytes": 52 }
}

url is the link to share.

Pages

Page data

A JSON object per page that the published page reads with docpin.data(). See Page data.

Up to 1 MB per page, measured as JSON text.

Versions

Every publish to the same slug is kept.

Boards

Boards group pages under one landing page, like /team-updates.

Status codes