List bulk renders

GET /api/render/bulk

List the account's bulk render batches with per-state job counts.

Authentication

Option 1: x-api-key: YOUR_API_KEY (header). API key for authentication. Create one in your dashboard.
Option 2: Authorization: Bearer YOUR_ACCESS_TOKEN. Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.

Create API keys at app.zvid.io/api-keys. Keep credentials on your server.

Parameters

Parameter	Location	Type	Required	Description and constraints
`page`	query	integer	No	Default: `1`. Minimum: `1`.
`limit`	query	integer	No	Default: `20`. Minimum: `1`. Maximum: `100`.

Request

The shell examples read credentials from ZVID_API_KEY (or ZVID_ACCESS_TOKEN for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

Request example

curl --request GET 'https://api.zvid.io/api/render/bulk' \
  --header "x-api-key: $ZVID_API_KEY"

Responses

HTTP 200

Bulk render batches for the authenticated account

Content type: application/json.

Required properties: bulks, pagination.

Field	Type	Required	Description and constraints
`response.bulks`	array of BulkRenderSummary	Yes
`response.pagination`	Pagination	Yes

Nested field: response.bulks

Array item: response.bulks[]

Schema: BulkRenderSummary.

Example response

{
  "bulks": [
    {
      "id": "blk_CL7FunS6EL0C7qeES6y4",
      "name": "spring-campaign",
      "templateId": "tpl_rAequJHzUETcLAMfrezk",
      "type": "video",
      "status": "completed",
      "totalJobs": 25,
      "creditsReserved": 150,
      "counts": {
        "completed": 24,
        "failed": 1,
        "pending": 0
      },
      "createdAt": "2026-07-05T10:39:27.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 5,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

HTTP 401

Unauthorized

Content type: application/json.

Unknown properties are rejected. Required properties: error.

Field	Type	Required	Description and constraints
`response.error`	string	Yes	Error type
`response.message`	string	No	Human-readable error message

Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.

BulkRenderList

Required properties: bulks, pagination.

Field	Type	Required	Description and constraints
`BulkRenderList.bulks`	array of BulkRenderSummary	Yes
`BulkRenderList.pagination`	Pagination	Yes

Nested field: BulkRenderList.bulks

Array item: BulkRenderList.bulks[]

Schema: BulkRenderSummary.

BulkRenderSummary

One bulk render batch as returned by the bulk list endpoint.

Required properties: id, type, status, totalJobs, createdAt.

Field	Type	Required	Description and constraints
`BulkRenderSummary.id`	string	Yes
`BulkRenderSummary.name`	string / null	No
`BulkRenderSummary.templateId`	string / null	No
`BulkRenderSummary.type`	`"video"` / `"image"`	Yes
`BulkRenderSummary.status`	string	Yes
`BulkRenderSummary.totalJobs`	integer	Yes
`BulkRenderSummary.creditsReserved`	number	No
`BulkRenderSummary.counts`	object	No	Per-state job counts inside the batch
`BulkRenderSummary.createdAt`	string	Yes	Format: `date-time`.

Nested field: BulkRenderSummary.counts

Per-state job counts inside the batch

Field	Type	Required
`BulkRenderSummary.counts.completed`	integer	No
`BulkRenderSummary.counts.failed`	integer	No
`BulkRenderSummary.counts.pending`	integer	No

Pagination

Standard pagination envelope for list endpoints.

Required properties: page, limit, total, totalPages.

Field	Type	Required	Description and constraints
`Pagination.page`	integer	Yes
`Pagination.limit`	integer	Yes
`Pagination.total`	integer	Yes
`Pagination.totalPages`	integer	Yes
`Pagination.hasNext`	boolean	No	Whether there are more pages after the current one
`Pagination.hasPrev`	boolean	No	Whether there are pages before the current one

AuthenticationError

Unknown properties are rejected. Required properties: error.

Field	Type	Required	Description and constraints
`AuthenticationError.error`	string	Yes	Error type
`AuthenticationError.message`	string	No	Human-readable error message

Authentication​

Parameters​

Request​

Request example​

Responses​

HTTP 200​

HTTP 401​

Schema definitions​

Related resources​