HEheygen
Batches

Get Video Batch

Changed on

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.

get/v3/videos/batches/{batch_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/videos/batches/{batch_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

batch_idstring required

Unique video batch identifier returned by POST /v3/videos/batches

Query parameters

limitinteger

Items per page (1-100).

tokenstring

Opaque pagination cursor from a previous response.

Response

Successful response

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status