POST
/
api
/
lipsyncs_v2
/
{id}
/
render

​
About Request Data Structure of Webhook

When the ‘create a lipsync task’ interface is requested, if the ‘webhook_url’ is passed in the parameters, the program will initiate a POST request to this network address when the task succeeds or fails, with the following content:

{
    'id': 'string',
    'status': 'string',
    'failed_reason': 'string',
    'output': 'string',
}

Arguments:

  • id (string): The unique identifier of the job
  • status (string): The status of the job. Possible values are pending, in_queue, running, failed, done
  • failed_reason (string): The reason of the failure if the job failed
  • output (string): The URL of the video if the job is done

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

​
id
string
required

A UUID string identifying this lipsync.

Response

200 - application/json
​
created_at
string
required
​
credits_used
integer
required

Credits used in this api call

​
failed_reason
string | null
required

The reason for failure, if the lipsync request failed

​
id
string
required
​
output
string | null
required

Output video

​
preview
string | null
required

Preview video

​
progress
string
required
​
status
string
required

Status of the lipsync request

​
updated_at
string
required
​
media_job
string | null

The media job associated with the lipsync request.

​
name
string | null

The name of the lipsync request.

Maximum length: 255
​
webhook_url
string | null

The webhook URL to be called upon completion of the lipsync request

Maximum length: 200
Generate Preivew of lipsync v2Generate AI Scripts