Skip to main content

Authentication

The public OpenDocs API is hosted at:

https://api.opendocs.cc

Most external integrations use an API key in the Authorization header.

API key authentication​

API keys start with:

od_live_

Send the key as a bearer token:

curl https://api.opendocs.cc/api/v1/me \
  -H "Authorization: Bearer od_live_xxxxx"

Session authentication​

Some endpoints in the wider application use browser session auth for dashboard and workspace management flows. This public reference focuses on the routes that external users can call directly.

Required headers​

For JSON requests:

Authorization: Bearer od_live_xxxxx
Content-Type: application/json

Getting a key​

  1. Sign up at opendocs.cc/signup
  2. Complete onboarding
  3. Open Dashboard -> API Keys
  4. Create a key

Common auth failure​

If the key is missing, revoked, or malformed, the API returns:

{
  "error": "unauthorized"
}

Routes in this public reference​

  • GET /api/v1/usernames/check
  • GET /api/v1/me
  • POST /api/v1/publish
  • GET /api/v1/posts
  • GET /api/v1/posts/:postId
  • GET /api/v1/posts/:postId/raw
  • POST /api/v1/posts/:postId/update
  • POST /api/v1/posts/:postId/unpublish
  • POST /api/v1/posts/:postId/visibility
  • PATCH /api/v1/posts/:postId/tags