Skip to content
Notavia Notavia Docs

API Reference

Every Notavia feature is built on the public REST API. The pages in this section are generated from the OpenAPI specification and cover every endpoint, parameter, request body, and response.

Authentication

Section titled “Authentication”

All /v1/* endpoints require a bearer API key:

Authorization: Bearer nsk_live_...

See Authentication & environments for key types, scopes, and the test / live split.

Try it live

Section titled “Try it live”

Prefer an interactive explorer? Every self-hosted Notavia deployment serves a Scalar “try-it” explorer at /docs on the API host — send real requests with your own key against your own instance.

Conventions

Section titled “Conventions”
  • Base URL — your Notavia host (managed or self-hosted).
  • Errors — a consistent shape: a machine-readable code plus a human message. See Core concepts.
  • Idempotency — write endpoints accept an idempotency key. See Core concepts.