API overview
Base URL, authentication, request and response conventions, headers, pagination, idempotency, retries, versioning, and a map of every endpoint.
Authentication
API keys, test and live environments, scopes, key handling and rotation, session tokens of the app and AI agents, and how the CLI logs in.
Rendering
POST /v1/renders in depth: the request fields, the three sources, output formats, settings overrides, data checks, file names, download links and retention, sync and async, time limits, post-processing, deduplication and reproducibility.
Async and batch
Queue long renders, process up to 1,000 documents in one job, get a zip, and learn about results through webhooks or polling.
PDF tools
Merge, password-protect, watermark and inspect PDFs, and convert office documents to PDF: the post block of a render and the /pdf endpoints, what they cost, the order of the steps and the errors they return.
Files
Upload the images and PDFs your templates use to the workspace file library, reference them by name with asset(), and use them as PDF watermarks and merge sources.
Brand and partials
Read the organisation's brand kit with GET /brand and manage shared partials with the partials endpoints, including conflict detection with base_version.
Webhooks
Events, payloads, signature verification in Node, Python and any language, retries, and how to build a reliable handler.
Develop webhooks locally
Forward your workspace's webhook events to a server on your machine with formfeed listen, verify them with the session secret, send events again and trigger real ones.
Bring your own storage
Copy every document into your own Amazon S3, Cloudflare R2 or S3-compatible bucket: connecting a bucket, minimal permissions per provider, object keys, the storage option of a request, retries and pausing, redelivery, the storage events and the storage field.
Templates API
Create templates, add and publish versions, detect conflicts with base_checksum, check data schemas before publishing, manage release channels, and read data schemas from code.
Limits and usage
Rate limits, concurrency, page, size and retention limits per plan, how units are counted, billing periods, quota and spending limit, and reading usage from the API.
Errors
46 items
Data residency
Where Formfeed processes and stores your data, what leaves the EU, how long it is kept, and how to keep it that way.
apitemplate.io compatibility endpoints
Keep your apitemplate.io integration running while you migrate; four endpoints with their request and response shapes.
SDKs
2 items
Reference
11 items