Start here
Generate your first PDF
Create a template, get an API token, and generate a PDF with one authenticated request.
Reviewed 2026-08-05 · PDFDesignAPI Engineering
Before you start
Create a free PDFDesignAPI account and open the visual designer.
Create a template, define its data schema, bind at least one field, and copy the template UUID from the API screen.
Create an API token and keep it in server-side secret storage. Never expose it in browser code or commit it to source control.
Send a generation request
Send your template data under the data property. The successful response is a binary PDF.
curl -X POST "https://pdfdesignapi.com/api/v1/generate/single/TEMPLATE_UUID" \
-H "Authorization: Bearer API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"data":{"customer":{"name":"Example BV"}}}' \
--output result.pdfCheck the result
Open result.pdf and verify that the bound value appears in the expected component.
If validation fails, inspect the structured error, compare the payload with the template contract, and retry only after correcting the data.
Choose the next workflow
Use synchronous generation for interactive requests that complete within the calling request.
Use asynchronous jobs for heavier documents and batch generation for multiple payloads.
Promote a tested immutable template version through development, staging, and production before relying on it in a production integration.