---
title: "Get Video Batch"
method: GET
path: "/v3/videos/batches/{batch_id}"
tags: ["Batches"]
---

# Get Video Batch

`GET /v3/videos/batches/{batch_id}`

Returns batch aggregate status and one page of items with their video ids and statuses. Item statuses are one of queued, processing, completed, or failed.

## Path parameters

- `batch_id` string, required

## Query parameters

- `limit` integer
- `token` string

## Response `200`

Successful response

- object
  - `data` VideoBatchDetail
    - `batch_id` string, required — Batch identifier.
    - `title` string, nullable — Batch display name.
    - `status` 'processing' | 'completed' | 'failed', required
    - `total_items` integer, required — Number of items submitted in this batch.
    - `counts_by_status` object, required — Item counts keyed by item status.
    - `created_at` integer, required — Batch creation time as a unix timestamp.
    - `items` VideoBatchItem[], required — One page of batch items ordered by item_index.
      - `item_index` integer, required — Zero-based position of this item in the submitted videos array.
      - `status` 'queued' | 'processing' | 'completed' | 'failed', required
      - `video_id` string, nullable — Video id, present once the underlying video has been created.
      - `error` object, nullable — Failure details when status is failed.
    - `has_more` boolean, required — Whether more items exist beyond this page.
    - `next_token` string, nullable — Opaque cursor for the next page of items.

## Other responses

- `400` — Invalid request parameters
- `401` — Authentication failed
- `404` — Resource not found
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/heygen/apis/heygen-external-api.md) · [All operations](https://skmtc.net/heygen/apis/heygen-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heygen/heygen-external-api/revisions/e2e54726e210/schema)