Batches

Create a batch

One PDF per item (or spreadsheet row) from one template, rendered in the background. batch.completed is sent when every item is done; the ZIP link is on the batch.

post/v1/batches

Request

  • Base URL: https://api.castpdf.com
  • URL: https://api.castpdf.com/v1/batches
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

1 to 255 printable ASCII characters. The same key and body within 24 hours return the first result instead of doing the work again.

Request body

template_idstring required
template_versioninteger
filename_patternstring
mode'fast' | 'print'
orientation'portrait' | 'landscape'
marginsstring
metadataobject
testboolean

Response

Queued.

idstring uuid
status'queued' | 'processing' | 'completed' | 'canceled'
livemodeboolean
source'api' | 'spreadsheet'
template_idstring uuid
template_versioninteger
totalinteger
queuedinteger
processinginteger
succeededinteger
failedinteger
canceledinteger
created_atstring date-time
completed_atstring date-time nullable
metadataobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.