> ## Documentation Index > Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get Video Batch > 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. ## OpenAPI ````yaml /openapi/external-api.json get /v3/videos/batches/{batch_id} openapi: 3.1.0 info: title: HeyGen External API version: 1.0.0 description: >- HeyGen's external API for programmatic AI video creation. See https://docs.heygen.com for full documentation. contact: name: HeyGen Product Infra url: https://heygen.com servers: - url: https://api.heygen.com description: Production security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: Video Agent description: Create videos from text prompts using AI - name: Videos description: Create, list, retrieve, and delete videos - name: Templates description: Generate videos from reusable templates by replacing their variables - name: Voices description: Text-to-speech and voice management - name: Audio description: Search the background-music and sound-effects catalog - name: Video Translate description: Translate videos into other languages - name: AI Clipping description: Turn long-form videos into ready-to-share short clips with captions - name: Batches description: Create and track batches of videos. - name: User description: Account information and billing - name: Avatars description: List and manage avatars and looks - name: Avatar Realtime description: >- Low-latency streaming avatar sessions — create a stream, poll for its HLS URL, push text, consume per-word timestamps - name: Assets description: Upload files for use in video creation - name: Webhooks description: Manage webhook endpoints and events - name: Lipsync description: Dub or replace audio on existing videos - name: Brand description: >- Brand-related resources — brand kits (colors, fonts, logos) and brand glossaries (custom term translations) - name: HyperFrames description: Render HyperFrames composition zips into video — separate from /v3/videos paths: /v3/videos/batches/{batch_id}: get: tags: - Batches summary: Get Video Batch description: >- 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. operationId: getVideoBatchV3 parameters: - name: batch_id in: path required: true schema: type: string description: Unique video batch identifier returned by POST /v3/videos/batches - name: limit in: query required: false description: Items per page (1-100). schema: type: integer minimum: 1 maximum: 100 default: 100 - name: token in: query required: false description: Opaque pagination cursor from a previous response. schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/VideoBatchDetail' '400': description: Invalid request parameters content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' '401': description: Authentication failed content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: authentication_failed message: Invalid or expired API key. Verify your x-api-key header. param: null doc_url: null '404': description: Resource not found content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: not_found message: Batch not found. param: null doc_url: null '429': description: Rate limit exceeded content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: rate_limit_exceeded message: >- Too many requests. Retry after the duration specified in the Retry-After header. param: null doc_url: null headers: Retry-After: description: Seconds to wait before retrying schema: type: integer security: - ApiKeyAuth: [] - BearerAuth: [] components: schemas: VideoBatchDetail: properties: batch_id: description: Batch identifier. title: Batch Id type: string title: anyOf: - type: string - type: 'null' default: null description: Batch display name. title: Title status: $ref: '#/components/schemas/BatchStatus' description: Aggregate batch status derived from item states. total_items: description: Number of items submitted in this batch. title: Total Items type: integer counts_by_status: additionalProperties: type: integer description: Item counts keyed by item status. title: Counts By Status type: object created_at: description: Batch creation time as a unix timestamp. title: Created At type: integer items: description: One page of batch items ordered by item_index. items: $ref: '#/components/schemas/VideoBatchItem' title: Items type: array has_more: description: Whether more items exist beyond this page. title: Has More type: boolean next_token: anyOf: - type: string - type: 'null' default: null description: Opaque cursor for the next page of items. title: Next Token required: - batch_id - status - total_items - counts_by_status - created_at - items - has_more title: VideoBatchDetail type: object StandardAPIError: type: object properties: code: type: string description: Machine-readable error code example: invalid_parameter message: type: string description: Human-readable error message example: Video not found param: type: - string - 'null' description: Which request field caused the error doc_url: type: - string - 'null' description: Link to error documentation required: - code - message BatchStatus: enum: - processing - completed - failed title: BatchStatus type: string VideoBatchItem: properties: item_index: description: Zero-based position of this item in the submitted videos array. title: Item Index type: integer status: $ref: '#/components/schemas/BatchItemStatus' description: 'Item status: queued | processing | completed | failed.' video_id: anyOf: - type: string - type: 'null' default: null description: Video id, present once the underlying video has been created. title: Video Id error: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Failure details when status is failed. title: Error required: - item_index - status title: VideoBatchItem type: object BatchItemStatus: enum: - queued - processing - completed - failed title: BatchItemStatus type: string securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: HeyGen API key. Obtain from your HeyGen dashboard. BearerAuth: type: http scheme: bearer description: OAuth2 bearer token. ````