Skip to main content
POST
Create a batch

Phase

Phase 1 (Launch)

Request

array
required
Array of PDF generation requests. Each item follows the same schema as POST /v1/pdfs, plus an optional template_id + data for template-based generation.Max items per batch: plan-dependent (5 for Free, up to 2,000 for Scale).
string
URL to receive webhook notifications for this batch. Overrides your account-level webhook for this job. Events: batch.completed, batch.failed, batch.item.completed, batch.item.failed.
integer
default:"5"
Max items to render concurrently within this batch. Capped by your plan’s concurrency limit.
boolean
default:"false"
If true, stop processing remaining items when any item fails. Completed items are still available.
string
default:"individual"
How to deliver results:
  • individual — Each item gets its own PDF URL.
  • merged — All items are merged into a single PDF in order.
  • zip — All items are bundled into a ZIP file.
object
Metadata attached to the batch job.

Item schema

Each item in the items array accepts:
Or for template-based generation:
All fields from POST /v1/pdfs are supported per-item (format, margin, compress, etc.).

Response

Batches are asynchronous. The response returns immediately with a processing status:
Poll GET /v1/batches/:id or listen for webhooks to track progress.

Example