Airpdf documentation
PDF generation infrastructure for modern SaaS — JSON-tree templates, REST API, customer-owned storage.
Why Airpdf
- Visual editor for templates with live PDF preview (REPL-style JSX → JSON tree).
- Multi-tenant SaaS: every workspace gets its own API keys, templates, storage routing.
- 2-6× cheaper than DocRaptor on every tier.
- Customer-owned storage (Bring Your Own S3 / R2 / MinIO / Wasabi).
- 12 official SDKs, hand-crafted for the four most popular (Node, Python, Go, Ruby).
- Webhook delivery with HMAC-SHA256 signature + replay protection.
Where to start
Just looking around?
Read the Quickstart — render your first PDF in 5 minutes.
Ready to integrate?
Follow the Integration guide. It walks you from signup to production-ready setup.
Looking for the API spec?
The REST API reference has every endpoint, request/response shape, and error code. A Postman collection and OpenAPI 3.1 spec are also published.
Building with a specific language?
Browse the SDK catalogue — Node, Python, Go, Ruby (Tier 1, fully maintained), plus 8 more languages in preview.
Concept overview
| Concept | What |
|---|---|
| Workspace (tenant) | Isolated environment with its own users, templates, API keys, storage |
| Template | A JSON-tree document definition (Document → Page → View / Text / Image / List). Identified by a slug. |
| API key | Bearer token, two environments per workspace: airpdf_test_* (sandbox) and airpdf_live_* (production) |
| Render request | A single POST /api/v1/render call. Sync (PDF in body) or async ({id, poll_url} + webhook on completion) |
| Variables schema | JSON Schema attached to each template, validates the data field of incoming render requests |
| Storage routing | Airpdf uploads PDFs to its managed Wasabi bucket by default. Customers can provide their own S3-compatible bucket. |
| MonthlyUsage | Counter that resets every billing cycle. Used for plan quota enforcement and overage billing. |
Get help
- 📧 hello@airpdf.io — we reply within 24h on paid plans
- 🟢 Status page — live system health
- 💬 GitHub Discussions on each SDK repo
All pages
Getting started
- Quickstart — Make your first API call in 5 minutes. Sign up, generate an API key, render a PDF.
- Integration guide — Integrate Airpdf into your application — workspace setup, API keys, templates, sync vs async, webhooks, BYO storage.
API
- REST API reference — Complete reference for the Airpdf Render API: render, render_async, get_render, list_templates, get_template.
- Error reference — All HTTP status codes and error_code values returned by the Airpdf API. Stable codes, retry guidance.
- Webhooks — HMAC-SHA256 signed webhook deliveries. Headers, signature scheme, replay protection, verification examples.
SDKs
- Official SDKs — 12 client libraries: Node.js, Python, Ruby, PHP, Go, Java, .NET, Elixir, Rust, Kotlin, Swift, Dart.
MCP
- Connect to Claude / Cursor (MCP) — Connect Airpdf to Claude Desktop or any MCP-aware client in 60 seconds. List, draft, preview and publish PDF templates from chat.
- MCP tool reference — Schemas, arguments and returns for the 8 tools the Airpdf MCP server exposes (list/get/create/update/publish_template, preview_render, validate_data, author_guide).
Reference
- Template schema reference — JSON-tree primitives (Document, Page, View, Text, Image, List), style values, variables interpolation.
- HTML render engine — Second-generation Chromium HTML+CSS engine for pixel-perfect output. Enablement, quota multiplier, rate limits, security model.
- Pricing tiers — Free $0 · Starter $9 · Growth $24 · Business $49 · Scale $99 · Enterprise custom. Effective $/PDF, overage rates, test-mode renders.