Lipsync

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

get/v3/lipsyncs/{lipsync_id}

Request

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

Path parameters

lipsync_idstring required

Unique lipsync identifier

Response

Successful response

Example response

{
  "data": {
    "failure_code": "hf_usage_exhausted"
  }
}

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

    • info

      added the optional property / to the response with the status