Introduction | NookDocs

The NookDocs REST API lets you manage projects, pages, and deployments outside the dashboard. Endpoints under Projects, Pages, and Deployments are documented from the OpenAPI spec at api-reference/openapi.json.

Base URL

https://api.nookdocs.com/v1

Authentication

The API uses API keys. Include your key in the Authorization header on every request.

Getting an API key

Go to Settings → API Keys in the dashboard
Click Create API Key, pick the scopes it needs
Copy the key — it's only shown once

Name the key, then untick the scopes it shouldn't have

Making requests

curl https://api.nookdocs.com/v1/projects \
  -H "Authorization: Bearer nook_..."

API key scopes

Scope	Description
`projects:read`	List and get projects
`projects:write`	Create, update, delete projects; manage the project logo
`pages:read`	List and get pages
`pages:write`	Reserved — page writes are dashboard/Git-only today; this scope unlocks future page-write endpoints
`deployments:read`	List deployments
`deployments:trigger`	Trigger manual deployments
`analytics:read`	Read the analytics overview, breakdowns, and AI & LLM insights
`scim`	SCIM 2.0 user/group provisioning — required by the `/scim/v2/*` endpoints (Enterprise SSO)

Requests made with a key that lacks the required scope return 403. Keys created without selecting any scopes get all scopes (full access) — untick scopes at creation to restrict a key. Scopes can be edited later from the same Settings → API Keys list.

Key expiry

Keys can be created with an optional expiry. An expired key stops authenticating immediately — requests return 401. Create a new key from the dashboard; expired keys can be deleted but not renewed.

Rate limits

There are no hard per-minute limits enforced today — the API is subject to fair use. Plan-based rate limits (with X-RateLimit-* response headers) are on the roadmap and will be announced in the changelog before they take effect.