Introduction
Typefold turns HTML, or a template plus JSON data, into PDF and Excel files. Your application calls its HTTP API with an API key and gets the finished file in the response or from a background render. Your team writes and previews templates in Studio, a web app that also manages API keys, teammates and webhooks.
What it is good for
Section titled “What it is good for”Documents your application produces again and again from data:
- Invoices, receipts and e-invoices with an embedded XML file.
- Statements and reports, as a PDF or as a real
.xlsxworkbook. - Tickets, certificates, labels and letters.
- Archival and accessible PDFs (PDF/A and PDF/UA).
- Short email and SMS texts, written in the same template language.
It is a poor fit for turning arbitrary web pages into PDFs: it is not a browser, so it does not run the page’s JavaScript and supports its own set of CSS. See supported CSS and what is not supported.
Hosted or self-hosted
Section titled “Hosted or self-hosted”The API, Studio and templates work the same in both.
- Hosted. Sign in to Studio, create a workspace and an API key. Nothing to install.
- Self-hosted. Run Typefold on your own server, so documents and templates never leave your network. It needs a license key to render. See install.
Where to go next
Section titled “Where to go next”- Trying it out? The quickstart takes you from an API key to a downloaded PDF.
- Want the big picture? How it works explains workspaces, API keys, templates and renders.
- Integrating an application? Render a template by name with the Reports API, or run background render jobs and batches with the Renders API. Call the HTTP API directly, or use the .NET, Python or TypeScript client.
- Writing templates? Build your first template in Studio.
- Running your own server? Start with install.