Bulk Lipsync Statuses

Returns statuses for up to 100 lipsyncs in one request, addressed by comma-separated lipsync_ids and/or batch_ids query params. Statuses are one of queued, processing, completed, or failed, plus not_found for unknown or unowned ids. Each returned entry carries its id as video_id (the status read model is shared with the videos batch API).

GET /v3/lipsyncs/statuses

Bulk Lipsync Statuses

cURL

curl --request GET \
  --url https://api.heygen.com/v3/lipsyncs/statuses \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.heygen.com/v3/lipsyncs/statuses"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.heygen.com/v3/lipsyncs/statuses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/lipsyncs/statuses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/lipsyncs/statuses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.heygen.com/v3/lipsyncs/statuses")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/lipsyncs/statuses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "status": "<string>",
      "video_id": "<string>",
      "error": {},
      "batch_id": "<string>",
      "item_index": 123
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "At most 100 ids per request.",
    "param": "lipsync_ids",
    "doc_url": null
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

lipsync_ids · string

Comma-separated lipsync ids to look up.

batch_ids · string

Comma-separated batch ids; each expands to its member lipsyncs.

Response

200

application/json

Successful response

data · VideoStatusEntry · object[]

Show child attributes

has_more · boolean

Whether more pages are available

next_token · string | null

Opaque cursor for the next page