HEheygen
Lipsync Batches

Get Lipsync Batch

Changed on

Returns batch aggregate status and one page of items with their ids and statuses. Item statuses are one of queued, processing, completed, or failed. The per-item id is returned as video_id (the batch read model is shared with the videos batch API).

get/v3/lipsyncs/batches/{batch_id}

Request

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

Path parameters

batch_idstring required

Unique lipsync batch identifier returned by POST /v3/lipsyncs/batches

Query parameters

limitinteger

Items per page (1-100).

tokenstring

Opaque pagination cursor from a previous response.

Response

Successful response

Changes