Skip to main content
GET
/
batches
/
{batchId}
Get a batch by ID
curl --request GET \
  --url https://api.blurb.fail/v1/batches/{batchId}
{
  "success": true,
  "message": "Batch found",
  "data": {
    "orgId": "example",
    "mediaId": "example",
    "mediaBundleId": "example",
    "batchId": "example",
    "dryRun": null,
    "useV3": null,
    "status": null,
    "artistId": "example",
    "renders": [
      {
        "orgId": "example",
        "webhookUrl": null,
        "batchId": "example",
        "videoSettings": {
          "aspectRatio": null
        },
        "dryRun": null,
        "useV3": null,
        "ref": "example",
        "renderId": "example",
        "aspectRatio": "example",
        "message": "example",
        "progress": 3,
        "createdAt": "example",
        "renderUrl": "example",
        "thumbnailUrl": "example",
        "status": null,
        "contentId": "example"
      }
    ],
    "effectOverrides": null,
    "serviceParams": null,
    "type": "RENDER",
    "createdAt": "example"
  }
}

Path Parameters

​
batchId
string
required
Example:

"my-batch-id"

Response

Batch found

​
success
boolean
required

Whether the request was successful

Example:

true

​
message
string | null
required

Message from the API

Example:

"Batch found"

​
data
object
required

The response from the Batch GET request.

Example:
{
  "orgId": "example",
  "mediaId": "example",
  "mediaBundleId": "example",
  "batchId": "example",
  "dryRun": null,
  "useV3": null,
  "status": null,
  "artistId": "example",
  "renders": [
    {
      "orgId": "example",
      "webhookUrl": null,
      "batchId": "example",
      "videoSettings": { "aspectRatio": null },
      "dryRun": null,
      "useV3": null,
      "ref": "example",
      "renderId": "example",
      "aspectRatio": "example",
      "message": "example",
      "progress": 3,
      "createdAt": "example",
      "renderUrl": "example",
      "thumbnailUrl": "example",
      "status": null,
      "contentId": "example"
    }
  ],
  "effectOverrides": null,
  "serviceParams": null,
  "type": "RENDER",
  "createdAt": "example"
}