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>"
}

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