PaperDB

PaperDB

Docs

PaperDB docs

Build against the verified V1 contract.

PaperDB is a schema-guided backend platform for teams that want a modern control plane without inventing one from scratch. The docs in this section describe the routes, SDK methods, and operational expectations that are actually available today.

Current platform shape

  • Auth, CRUD, bulk/count, schema, webhooks, cron, realtime, and dashboard APIs are documented and working.
  • Storage is available for metadata and upload flows; object storage integration is still the gating item for full parity.
  • Search, magic-link auth, password reset, and offline sync should be treated as future work until the backend contract lands.
The safest way to use PaperDB is to treat the OpenAPI document and the SDK README as the current truth, then use this landing page as the map.

Getting Started

How it worksInstallation

SDK

AuthenticationAPI Reference

Core Concepts

DatabasesCollectionsDocuments

Database Operations

CreateReadUpdateDeleteAggregation

Platform Features

WebhooksRealtimeCron JobsStorage

Recommended reading order

  • Start with How it works to learn the service layout.
  • Move to Installation andAuthentication for the first working client flow.
  • Use the operation pages for CRUD, storage, webhooks, cron, and realtime once you are wiring an app.
How it works →