Skip to main content
POST
/
batches
Create batch of jobs
curl --request POST \
  --url https://api.nexrender.com/api/v2/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobs": [
    {
      "template": {
        "id": "<string>",
        "src": "<string>",
        "composition": "<string>"
      },
      "preview": false,
      "fonts": [],
      "assets": [],
      "settings": {
        "type": "video",
        "frames": 1,
        "quality": "draft",
        "codec": "<string>"
      },
      "upload": {
        "prefix": "<string>",
        "outputUrl": "<string>",
        "provider": "s3",
        "params": {
          "region": "<string>",
          "bucket": "<string>",
          "accessKeyId": "<string>",
          "accessKeySecret": "<string>",
          "endpoint": "https://s3.amazonaws.com",
          "acl": "<string>"
        }
      },
      "webhook": {
        "url": "<string>",
        "method": "POST",
        "headers": {},
        "data": {},
        "custom": false
      }
    }
  ]
}
'
{
  "batchId": "<string>",
  "status": "created",
  "totalJobs": 123,
  "successCount": 123,
  "jobs": [
    {
      "index": 123,
      "id": "<string>",
      "status": "<string>",
      "outputUrl": "<string>",
      "children": [
        {
          "id": "<string>",
          "status": "<string>",
          "outputUrl": "<string>",
          "missingFonts": [
            "<string>"
          ]
        }
      ],
      "missingFonts": [
        "<string>"
      ]
    }
  ],
  "errors": [
    {
      "index": 123,
      "error": "<string>",
      "errorCode": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using API tokens for team-based access control.

You can generate your own API token at: https://app.nexrender.com/team/settings

Body

application/json

Configuration for creating a batch of render jobs in a single request (1 to 1000 jobs)

​
jobs
object[]
required

Array of job configurations to create as a batch. Each item follows the same schema as a single job creation request.

Required array length: 1 - 1000 elements

Response

Batch created successfully. Check 'status' field: 'created' means all jobs succeeded, 'partial' means some failed (see 'errors' array).

Response after creating a batch of jobs, including per-job results and any errors

​
batchId
string
required

Unique batch identifier in ULID format for tracking the entire batch

​
status
enum<string>
required

'created' if all jobs succeeded, 'partial' if some failed, 'error' if all failed

Available options:
created,
partial,
error
​
totalJobs
integer
required

Total number of jobs in the batch request

​
successCount
integer
required

Number of successfully created jobs

​
jobs
object[]
required

Array of successfully created job details

​
errors
object[]

Array of errors for failed jobs (only present when status is 'partial' or 'error')