API reference

Base URL https://docsify.dev/api/v1. Every request carries Authorization: Bearer <token>. The API is served to the internal network only; from anywhere else every path under /api/ answers with the site's 404 page.

Endpoints

MethodPathDescription
GET/projectsProjects visible to the token.
GET/projects/{id}/documentsDocuments of a project, paginated with cursor.
POST/projects/{id}/documentsCreate a document from a JSON body.
GET/documents/{id}One document with its revision history.
POST/documents/{id}/exportRender a document to PDF or HTML; the job is asynchronous.
GET/jobs/{id}Status of an export job.

Errors

CodeMeaning
400Malformed request body or parameters.
401Expired or revoked token.
404Unknown path, or a resource the token cannot see.
429Project rate limit exceeded; retry after the interval in Retry-After.

Rate limits

Each project allows 600 requests per minute per token. Export jobs are limited separately to 20 per hour.