Skip to main content

OpenAPI spec

OpenDocs publishes a machine-readable OpenAPI document for agents, SDK generators, and tool builders:

https://docs.opendocs.cc/openapi.json

Use it when you want to generate a client, inspect request/response shapes, or give an agent a structured API surface. The spec focuses on the public launch surface: authentication probes, publishing, post management, exports, workspace switching support, API-key management, team invitations, and account deletion.

Fetch it​

curl https://docs.opendocs.cc/openapi.json

For local docs development:

curl http://localhost:3001/openapi.json

Auth model​

Most public automation endpoints use bearer API keys:

Authorization: Bearer od_live_xxxxx

Dashboard-only endpoints use a browser session cookie and are marked in the spec with the cookieAuth security scheme.

Notes for agents​

  • Prefer the CLI when the task starts from local Markdown files.
  • Use the API directly when building a service integration or custom tool.
  • POST /api/v1/publish/batch is the correct API shape for folder uploads.
  • GET /api/v1/workspaces is the API-backed way to discover workspace slugs for opendocs workspace use.