Skip to main content
GET
/
batches
/
{id}
Get batch status
curl --request GET \
  --url https://api.nexrender.com/api/v2/batches/{id} \
  --header 'Authorization: Bearer <token>'
{
  "batchId": "<string>",
  "status": "processing",
  "stats": {
    "total": 123,
    "finished": 123,
    "error": 123,
    "pending": 123
  },
  "jobs": [
    {
      "index": 123,
      "id": "<string>",
      "status": "<string>",
      "outputUrl": "<string>",
      "stats": {
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "startedAt": "2023-11-07T05:31:56Z",
        "finishedAt": "2023-11-07T05:31:56Z",
        "errorAt": "2023-11-07T05:31:56Z",
        "totalAssets": 123,
        "renderDuration": 123,
        "error": "<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

Path Parameters

id
string
required

Unique batch identifier in ULID format

Response

Successfully retrieved batch status and job details

Current status and progress of a batch of jobs

batchId
string
required

Unique batch identifier

status
enum<string>
required

Overall batch status based on aggregate job states

Available options:
processing,
finished,
error
stats
object
required

Aggregate statistics for all jobs in the batch

jobs
object[]
required

Individual job details within the batch