Skip to main content
GET
/
templates
/
batch
/
{batchId}
/
results
Get batch job results
curl --request GET \
  --url https://api.pictify.io/templates/batch/{batchId}/results \
  --header 'Authorization: Bearer <token>'
{
  "batchId": "<string>",
  "progress": 50,
  "totalItems": 123,
  "completedItems": 123,
  "failedItems": 123,
  "results": [
    {
      "index": 123,
      "success": true,
      "variables": [
        "<string>"
      ],
      "results": [
        {
          "layout": "twitter-post",
          "name": "Twitter/X Post",
          "url": "<string>",
          "width": 123,
          "height": 123,
          "format": "png",
          "id": "<string>"
        }
      ],
      "errors": [
        {
          "layout": "<string>",
          "error": "<string>"
        }
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key obtained from the Pictify dashboard

Path Parameters

batchId
string
required

Response

200 - application/json

Batch job status and results

batchId
string
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
partial,
cancelled
progress
integer
Required range: 0 <= x <= 100
totalItems
integer
completedItems
integer
failedItems
integer
results
object[]
createdAt
string<date-time>
startedAt
string<date-time>
completedAt
string<date-time>