Get Lipsync

Returns details for a lipsync job including status, video_url, caption_url, and failure info if applicable.

GET /v3/lipsyncs/{lipsync_id}

Get Lipsync

cURL

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

200

{
  "data": {
    "id": "<string>",
    "status": "pending",
    "title": "<string>",
    "duration": 123,
    "video_url": "<string>",
    "caption_url": "<string>",
    "callback_id": "<string>",
    "created_at": 123,
    "failure_message": "<string>"
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

lipsync_id · string · required

Unique lipsync identifier

Response

200

application/json

Successful response

data · LipsyncDetail · object

Detailed lipsync resource.

Show child attributes