Skip to main content
POST
/
templates
/
{uid}
/
batch-render
Batch render template
curl --request POST \
  --url https://api.pictify.io/templates/{uid}/batch-render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variableSets": [
    {}
  ],
  "format": "png",
  "quality": 0.9,
  "layout": "<string>",
  "layouts": [
    "<string>"
  ],
  "concurrency": 5
}
'
{
  "batchId": "<string>",
  "totalItems": 123,
  "message": "<string>"
}

​
Batch Operations

Generate multiple images from a single template with different variables. Ideal for bulk generation of social cards, certificates, or personalized content.

​
Endpoints

MethodEndpointDescription
POST/templates/{uid}/batch-renderStart batch job
GET/templates/batch/{batchId}/resultsGet results
POST/templates/batch/{batchId}/cancelCancel batch

​
Batch Status

StatusDescription
pendingJob created, waiting to start
processingCurrently rendering images
completedAll items processed successfully
partialCompleted with some failures
failedAll items failed
cancelledJob was cancelled

​
Webhook Notification

When a batch job completes, Pictify sends a batch.completed event to your webhook URL (if provided): 
{
  "event": "batch.completed",
  "data": {
    "batchId": "batch_xyz789",
    "status": "completed",
    "totalCount": 100,
    "completedCount": 100,
    "failedCount": 0
  }
}

​
Limits

PlanMax Items per BatchConcurrent Batches
Free101
Pro1003
Business1,00010
Enterprise10,000Unlimited

​
Best Practices

  1. Use webhooks — don’t poll for results; use webhooks for notification
  2. Handle failures gracefully — some items may fail; implement retry logic
  3. Batch appropriately — group related renders; avoid tiny batches
  4. Monitor progress — track batch status for long-running jobs
  5. Clean up — results are stored for 7 days; download and store permanently if needed

Authorizations

​
Authorization
string
header
required

API key obtained from the Pictify dashboard

Path Parameters

​
uid
string
required

Body

application/json
​
variableSets
object[]
required
Required array length: 1 - 100 elements
​
format
enum<string>
default:png
Available options:
png,
jpeg,
webp
​
quality
number
default:0.9
Required range: 0.1 <= x <= 1
​
layout
string

Layout variant to use for all batch items. Omit for default layout.

Pattern: ^[a-z0-9-]{1,64}$
​
layouts
string[]

Array of layout variant names to render for all batch items. Use instead of layout to render multiple layouts per item.

Pattern: ^[a-z0-9-]{1,64}$
​
concurrency
integer
default:5
Required range: 1 <= x <= 10

Response

202 - application/json

Batch job created

​
batchId
string
​
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
partial,
cancelled
​
totalItems
integer
​
message
string