Basalt docs
GitHub

API reference

Every operation the Basalt server serves under /api/v1 — 160 of them across 119 paths, generated from the OpenAPI 3.1.0 document the server emits from its own route table. If an endpoint is not here, it does not exist.

Start with API for authentication, error shapes, pagination and webhooks.

Workspaces and people

Workspaces, their members, groups and invitations, the capabilities of the calling account, and what the workspace has used of its plan.

Collections

The top level of the page tree, and who may see each one.

Outlines

Lithic’s outliner documents (ADR-0018): a structure block like a page, with its node tree inside its own document rather than in the page tree.

Pages

Creating, moving, trashing and restoring pages; their Markdown surface, field values, relations, backlinks, search, and the pages a person pins.

Databases and fields

The workspace field registry, databases and their bound fields, saved views, and row memberships.

Collaboration

Comments, page history, activity, notifications, attachments and the workspace symbol library.

Permissions and sharing

Per-page access control lists, restriction boundaries, public share links, and the token routes a stranger reads them through.

Automation

Personal access tokens, webhooks, import and export, and link unfurling — the operations where the instance talks to the outside world. Plus the one pair that runs the other way: the early-access signup, which is the only part of this API a caller reaches with no session at all.

Billing and invoices

The workspace’s subscription and billing details, and the invoices this instance issues in the operator’s own number range — plus the payment provider’s callback.

Instance administration

The operator back office: every workspace on this instance with its metadata and plan, the plan assignment, and the append-only trail of operator actions. Metadata only — the operator of a hosted Basalt is a data processor and these routes cannot return page titles, page contents or comments. Session-only, and restricted to the operators named in BASALT_OPERATORS.