API guides
Asynchronous and batch generation
Queue durable jobs, poll their status, and download private results.
Reviewed 2026-08-05 · PDFDesignAPI Engineering
Create an asynchronous job
POST /api/v1/generate/async/:templateUuid validates the request and returns a render job.
Use this flow when generation should not hold open an interactive HTTP request.
POST https://pdfdesignapi.com/api/v1/generate/async/TEMPLATE_UUID
Authorization: Bearer API_TOKEN
Content-Type: application/json
{"data":{"report":{"title":"Monthly report"}}}Poll and retrieve
GET /api/v1/render-jobs/:uuid returns the current job state.
After completion, GET /api/v1/render-jobs/:uuid/result returns the private PDF result. Results expire after 24 hours, so move them to your own authorized storage if longer retention is required.
Submit a batch
POST /api/v1/generate/batch/:templateUuid accepts multiple document items and validates all of them before jobs are created.
GET /api/v1/render-batches/:batchUuid reports the batch and its item states. Handle partial failures explicitly.