When to use batches
Use the batch endpoint when you need to generate more than a handful of PDFs at once:- Monthly invoice runs
- Bulk certificate generation
- Report exports
- Data migration (re-rendering documents)
Basic batch
Output modes
individual (default)
Each item produces its own PDF with its own URL:merged
All items are combined into a single PDF in order:zip
All items are bundled into a downloadable ZIP:Tracking progress
Batches are async. Poll or use webhooks:Polling
Webhooks
batch.item.completed— fired for each item (useful for progress bars)batch.completed— fired when all items are donebatch.failed— fired if the batch fails
Error handling
By default, a failed item doesn’t stop the batch. The batch completes with partial results:stop_on_failure: true to abort remaining items on the first failure.
Concurrency
Theparallel parameter controls how many items render simultaneously:
parallel: 20, the batch monopolizes your capacity — other API calls will queue.