Information
- OpenAPI version:
3.1.0
Overview
Notewright HTTP API 1.0.0
Section titled “Notewright HTTP API 1.0.0”The bearer-authenticated HTTP endpoints a deployed Notewright instance exposes.
The recommended way to drive this API is the notewright CLI, which is a client of these endpoints and handles authentication, connection resolution, and output formatting for you. Every operation here has a CLI command that targets a linked instance and sends the bearer token automatically, so you rarely need to call these routes by hand.
Authentication
Every route requires a bearer token equal to the instance’s SYNC_SHARED_SECRET, sent as an Authorization: Bearer <secret> header.
- A missing or wrong token returns
401 Unauthorized. - If the instance has no
SYNC_SHARED_SECRETconfigured, routes return500. - Unknown routes return
404with{ "error": "Not found" }.
Authentication
Section titled “ Authentication ”bearerAuth
Section titled “bearerAuth ”A bearer token equal to the instance’s SYNC_SHARED_SECRET.
Security scheme type: http