API Overview

The Notebind API is a REST API that returns JSON. All endpoints are served from https://notebind.com/api/.

Base URL

https://notebind.com/api

Authentication

All API requests require authentication via either:

• API key in the Authorization header: Bearer nb_sk_...
• Session cookie (automatic in browser)

See Authentication for setup details.

Response format

Every response follows a consistent envelope:

{
  "data": { ... },
  "error": null
}

On error:

{
  "data": null,
  "error": {
    "message": "Human-readable error description",
    "code": "ERROR_CODE"
  }
}

Error codes

Code	HTTP Status	Description
UNAUTHORIZED	401	Missing or invalid credentials
FORBIDDEN	403	Insufficient permissions
NOT_FOUND	404	Resource does not exist
VALIDATION_ERROR	400	Invalid request body or parameters
ALREADY_RESOLVED	400	Suggestion already accepted/rejected
TEXT_NOT_FOUND	409	Original text no longer in document
DB_ERROR	500	Internal database error

Content type

All request bodies must be JSON with the Content-Type: application/json header.

Note

Requests without Content-Type: application/json will be rejected with 403 Forbidden by SvelteKit’s CSRF protection.

Endpoints

Resource	Endpoints	Description
Documents	GET, POST, PATCH, DELETE	CRUD operations on markdown documents
Comments	GET, POST, PATCH, DELETE	Anchored comments with threading
Suggestions	GET, POST, PATCH, DELETE	Text replacement suggestions
Share Links	GET, POST, DELETE	Shareable document links with permissions
API Keys	GET, POST, DELETE	Manage API keys

Pagination

The document list endpoint supports pagination:

Parameter	Type	Default	Max	Description
limit	int	50	100	Number of items per page
offset	int	0	-	Number of items to skip

curl "https://notebind.com/api/documents?limit=10&offset=20" \
  -H "Authorization: Bearer nb_sk_YOUR_KEY"

Rate limiting

There are currently no rate limits. This may change in the future.