Documentation

Getting Started

Learn the basics of PaperCast and how to build your first document.

Welcome to the PaperCast API documentation. PaperCast is a Schema-First Document Builder. You design your layout using a JSON schema, and our engine renders it dynamically.

Installation

PaperCast packages are published on NPM and can be installed via your preferred package manager:

npm install @papercast/core @papercast/engine @papercast/react

Using Widgets

You can easily embed our widgets into your own document schemas. Below is a full-scale interactive example of an Invoice widget.

Invoice Example

This widget demonstrates how an invoice template renders in the engine.

Auto
Loading preview...

API Overview

To programmatically generate PDFs, send a POST request with your JSON schema to https://paper-cast-web.vercel.app/api/pdf.

fetch("https://paper-cast-web.vercel.app/api/pdf", {
  method: "POST",
  body: JSON.stringify(mySchema),
});