Endpoints
Version 1.0.0. 87 endpoints in 11 groups, each group with its parameters, request bodies and responses on one Markdown page.
Every group below links to the interactive reference, which loads on this page when JavaScript is enabled, to its own page and to its Markdown version.
Servers
- https://api-eu.dynamicdocumentapi.com — EU (Germany)
Renders
Create and manage renders (PDFs, images, HTML).
- GET /v1/f/{token} — Open a short file link
- POST /v1/images/from-html — Screenshot of HTML
- POST /v1/images/from-template — Image from a template
- POST /v1/images/from-url — Screenshot of a URL
- POST /v1/pdf/from-html — PDF from HTML
- POST /v1/pdf/from-markdown — PDF from Markdown
- POST /v1/pdf/from-template — PDF from a template
- POST /v1/pdf/from-url — PDF from a URL
- GET /v1/renders — List renders
- POST /v1/renders — Create a render
- GET /v1/renders/{render_id} — Retrieve a render
- POST /v1/renders/{render_id}/cancel — Cancel a render
- DELETE /v1/renders/{render_id}/files — Purge stored files
- GET /v1/renders/{render_id}/files/{file_id} — Download a render file
- GET /v1/renders/{render_id}/logs — Request/response log
Batches
Render one template for many items (JSON or CSV), plus an optional ZIP / merged PDF.
- GET /v1/batches — List batches
- POST /v1/batches — Create a batch
- GET /v1/batches/{batch_id} — Retrieve a batch
- POST /v1/batches/{batch_id}/cancel — Cancel a batch
- GET /v1/batches/{batch_id}/items — List batch items
- POST /v1/batches/{batch_id}/resend-emails — Resend a batch's failed emails
- POST /v1/batches/{batch_id}/retry-failed — Retry the failed items
Templates
Read published templates, versions and data schemas; create, publish and roll back.
- GET /v1/templates — List templates
- POST /v1/templates — Create a template
- GET /v1/templates/{template_id} — Retrieve a template
- DELETE /v1/templates/{template_id} — Delete a template
- PUT /v1/templates/{template_id}/draft — Replace the draft sources
- POST /v1/templates/{template_id}/publish — Publish the draft
- POST /v1/templates/{template_id}/rollback — Roll back to a version
- GET /v1/templates/{template_id}/schema — Data schema of a template
- GET /v1/templates/{template_id}/versions — List template versions
- GET /v1/templates/{template_id}/versions/{number} — Retrieve a template version
PDF tools
Merge, split, rotate, protect, unlock, inspect PDFs and convert them to PDF/A.
- POST /v1/pdf-tools/merge — Merge PDFs
- POST /v1/pdf-tools/metadata — Read or set PDF metadata
- POST /v1/pdf-tools/pdfa — Convert a PDF to PDF/A
- POST /v1/pdf-tools/protect — Password-protect a PDF
- POST /v1/pdf-tools/rotate — Rotate PDF pages
- POST /v1/pdf-tools/split — Split a PDF
- POST /v1/pdf-tools/unlock — Remove a PDF password
E-invoices
XRechnung, Factur-X / ZUGFeRD and EN 16931 invoices: standalone CII or UBL XML here; hybrid PDF/A-3b invoices through `output.einvoice` on any PDF render. Validated with KoSIT. `POST /v1/einvoices/validate` checks e-invoices you receive.
- POST /v1/einvoices — Create an e-invoice XML
- POST /v1/einvoices/validate — Validate an e-invoice
Uploads
Temporary files for PDF tools and batches.
- POST /v1/uploads — Upload a file (≤ 50 MB, kept 24 h)
Webhooks
Webhook endpoints, the delivery log and replays.
- GET /v1/events/samples/{event_type} — Get a sample event
- GET /v1/webhook-deliveries — List webhook deliveries
- GET /v1/webhook-deliveries/{delivery_id} — Retrieve a webhook delivery
- POST /v1/webhook-deliveries/{delivery_id}/replay — Replay a webhook delivery
- GET /v1/webhook-endpoints — List webhook endpoints
- POST /v1/webhook-endpoints — Create a webhook endpoint
- GET /v1/webhook-endpoints/{endpoint_id} — Retrieve a webhook endpoint
- PATCH /v1/webhook-endpoints/{endpoint_id} — Update a webhook endpoint
- DELETE /v1/webhook-endpoints/{endpoint_id} — Delete a webhook endpoint
- POST /v1/webhook-endpoints/{endpoint_id}/roll-secret — Roll the signing secret
- POST /v1/webhook-endpoints/{endpoint_id}/test — Send a test event
Storage
Your own S3/Azure/GCS buckets for render output (BYOS).
- GET /v1/storage-destinations — List storage destinations
- POST /v1/storage-destinations — Create a storage destination
- GET /v1/storage-destinations/{destination_id} — Retrieve a storage destination
- PATCH /v1/storage-destinations/{destination_id} — Update a storage destination
- DELETE /v1/storage-destinations/{destination_id} — Delete a storage destination
- POST /v1/storage-destinations/{destination_id}/test — Test a storage destination
Signed links
Image URLs rendered straight from a template.
- GET /l/{link_id}/{filename} — Render a signed link
- GET /v1/signed-links — List signed links
- POST /v1/signed-links — Create a signed link
- GET /v1/signed-links/{link_id} — Retrieve a signed link
- PATCH /v1/signed-links/{link_id} — Update a signed link
- DELETE /v1/signed-links/{link_id} — Delete a signed link
- POST /v1/signed-links/{link_id}/sign — Sign a link URL
Email renders through your own provider account (Brevo, SMTP, Postmark, Resend, Amazon SES or Microsoft 365): connections, rules per template, previews, tests, sends, delivery events and resends. Growth plan and up. While email delivery isn't enabled for a workspace yet, writes to its connections and rules answer `403 feature_not_enabled`.
- GET /v1/email-connections — List email connections
- POST /v1/email-connections — Create an email connection
- GET /v1/email-connections/{connection_id} — Retrieve an email connection
- PATCH /v1/email-connections/{connection_id} — Update an email connection
- DELETE /v1/email-connections/{connection_id} — Delete an email connection
- POST /v1/email-connections/{connection_id}/test — Test an email connection
- POST /v1/email-rules/preview — Preview a rule that is not saved yet
- GET /v1/email-rules/{rule_id} — Retrieve an email rule
- PATCH /v1/email-rules/{rule_id} — Update an email rule
- DELETE /v1/email-rules/{rule_id} — Delete an email rule
- POST /v1/email-rules/{rule_id}/preview — Preview an email rule
- POST /v1/email-rules/{rule_id}/test — Send a test email
- GET /v1/email-sends — List email sends
- GET /v1/email-sends/stats — Email statistics
- GET /v1/email-sends/{send_id} — Retrieve an email send
- GET /v1/email-sends/{send_id}/events — List a send's delivery events
- POST /v1/email-sends/{send_id}/resend — Resend an email
- GET /v1/templates/{template_id}/email-rules — List a template's email rules
- POST /v1/templates/{template_id}/email-rules — Create an email rule
Account
Plan, renders, limits and usage.
- GET /v1/account — Plan, renders and limits
- GET /v1/usage — Usage time series