Skip to main content
POST
Batch render template

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