> ## Documentation Index
> Fetch the complete documentation index at: https://www.nexrender.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get batch status

> Retrieve the current status and progress of a batch of jobs, including aggregate statistics and per-job details



## OpenAPI

````yaml /openapi.json get /batches/{id}
openapi: 3.0.4
info:
  title: Nexrender API
  version: '2.0'
  description: >
    REST API for the Nexrender cloud rendering platform, enabling programmatic
    control over After Effects template processing, job management, and asset
    handling.


    Features include:


    - Template upload and management (AEP, MOGRT, ZIP files)

    - Job creation and status monitoring with real-time progress

    - Job nesting for multi-composition renders (parent/child jobs)

    - Job stitching to combine multiple videos into one

    - Batch job creation for submitting up to 1000 jobs at once

    - Font library management for typography consistency

    - Secret management for secure API key storage

    - Webhook notifications for job lifecycle events

    - Asset injection for dynamic content replacement


    Authentication is required for all endpoints using Bearer token
    authorization.
servers:
  - url: https://api.nexrender.com/api/v2
    description: Production API server
security:
  - apiToken: []
paths:
  /batches/{id}:
    get:
      tags:
        - Batch Management
      summary: Get batch status
      description: >-
        Retrieve the current status and progress of a batch of jobs, including
        aggregate statistics and per-job details
      operationId: getBatchStatus
      parameters:
        - in: path
          name: id
          required: true
          description: Unique batch identifier in ULID format
          schema:
            type: string
            pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
      responses:
        '200':
          description: Successfully retrieved batch status and job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatusResponse'
        '400':
          description: Invalid batch ID format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: Unauthorized - invalid or missing API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - license is not valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Batch not found - no jobs exist with this batch ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BatchStatusResponse:
      type: object
      description: Current status and progress of a batch of jobs
      properties:
        batchId:
          type: string
          description: Unique batch identifier
        status:
          type: string
          enum:
            - processing
            - finished
            - error
          description: Overall batch status based on aggregate job states
        stats:
          type: object
          description: Aggregate statistics for all jobs in the batch
          properties:
            total:
              type: integer
              description: Total number of jobs in the batch
            finished:
              type: integer
              description: Number of successfully completed jobs
            error:
              type: integer
              description: Number of failed jobs
            pending:
              type: integer
              description: Number of jobs still processing or queued
        jobs:
          type: array
          description: Individual job details within the batch
          items:
            type: object
            properties:
              index:
                type: integer
                description: Position of this job in the original batch request
              id:
                type: string
                description: Unique job identifier
              status:
                type: string
                description: >-
                  Current job status. Manually cancelled jobs are returned as
                  `manually_cancelled`.
              outputUrl:
                type: string
                description: URL to the rendered output (available when finished)
              stats:
                type: object
                description: Job statistics (only included for finished or error states)
                properties:
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                  startedAt:
                    type: string
                    format: date-time
                    nullable: true
                  finishedAt:
                    type: string
                    format: date-time
                    nullable: true
                  errorAt:
                    type: string
                    format: date-time
                    nullable: true
                  totalAssets:
                    type: integer
                  renderDuration:
                    type: number
                    nullable: true
                  error:
                    type: string
                    nullable: true
      required:
        - batchId
        - status
        - stats
        - jobs
    ValidationErrorResponse:
      type: object
      description: Validation error response with detailed field information
      properties:
        error:
          type: string
          description: Main error message
        details:
          type: array
          description: Array of specific validation errors for individual fields
          items:
            type: object
            properties:
              field:
                type: string
                description: Field name that failed validation
              message:
                type: string
                description: Specific validation error for this field
    ErrorResponse:
      type: object
      description: Standard error response format
      properties:
        error:
          type: string
          description: Human-readable error message explaining what went wrong
      required:
        - error
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: >
        Bearer token authentication using API tokens for team-based access
        control.


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

````