Skip to main content
The Forme Dashboard is a reference implementation. The same operations are available to your own applications through the hosted API or a self-hosted server. Build custom document workflows without adopting the Forme UI.

Architecture

Your frontend collects user intent (what to redact, which PDFs to merge, which certificate to use). Your backend sends the structured request to Forme’s API and returns the result.
All /v1/* operation endpoints accept JSON and return PDF bytes (or JSON for rasterize). No cookies, sessions, or UI dependencies. The examples below use the hosted base URL, https://api.formepdf.com.

Custom Redaction UI

Build a UI where users draw boxes on a PDF preview, then send the coordinates to Forme:
To show a PDF preview for drawing, convert pages to images with POST /v1/rasterize on a self-hosted server (the hosted API does not serve it), or render pages in the browser with a PDF viewer, then overlay a canvas for region selection.

Custom Merge Workflow

Let users select and reorder PDFs, then merge:

Programmatic Certification

Certify documents as part of an approval workflow:

Preview Generation

Use rasterization on a self-hosted server to generate preview images for your own document viewer. POST /v1/rasterize is not available on the hosted API.

Resource Management

List your templates, documents, and certificates programmatically:
See Resources for the full listing API.

Self-Hosted

The operation endpoints /v1/render, /v1/certify, /v1/redact, /v1/merge, and /v1/rasterize work on self-hosted instances. Point your application at your own Forme container and avoid external API calls entirely. Some request bodies differ from the hosted API; see the self-hosted API reference. The features that require the hosted API are: saved templates (JSX and HTML + Liquid), POST /v1/render/html, async jobs and webhooks, saved certificates (certificateId), redaction templates (template slug), document storage, embedded-data extraction (/v1/extract), and resource listing.