Skip to main content
POST
/
templates
/
{uid}
/
render
Render a template
curl --request POST \
  --url https://api.pictify.io/templates/{uid}/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variables": {},
  "format": "png",
  "quality": 0.9,
  "layout": "<string>",
  "layouts": [
    "default",
    "twitter-post",
    "facebook-post"
  ]
}
'
{
  "results": [
    {
      "layout": "twitter-post",
      "name": "Twitter/X Post",
      "url": "https://cdn.pictify.io/renders/abc123.png",
      "width": 123,
      "height": 123,
      "format": "png",
      "id": "<string>"
    }
  ],
  "errors": [
    {
      "layout": "<string>",
      "error": "<string>"
    }
  ],
  "totalLayouts": 123,
  "totalRendered": 123,
  "totalErrors": 123,
  "templateUid": "<string>"
}

Authorizations

Authorization
string
header
required

API key obtained from the Pictify dashboard

Path Parameters

uid
string
required

Body

application/json
variables
object

Key-value pairs of template variable values

format
enum<string>
default:png

Output image format

Available options:
png,
jpeg,
webp,
pdf
quality
number
default:0.9

Image quality (0.1-1.0)

Required range: 0.1 <= x <= 1
layout
string

Render a specific layout variant (e.g. 'twitter-post', 'facebook-post'). Omit for default layout.

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

Render multiple layout variants in one request. Use 'default' for the base layout. Returns an array of results.

Maximum array length: 20
Example:
["default", "twitter-post", "facebook-post"]

Response

200 - application/json

Rendered image(s). Always returns a results array.

Render response. Always returns a results array, even for single-layout renders.

results
object[]

Array of rendered images, one per layout

errors
object[]

Layout keys that failed to render

totalLayouts
integer

Total number of layouts requested

totalRendered
integer

Number of successfully rendered layouts

totalErrors
integer

Number of failed layouts

templateUid
string

Template ID that was rendered