POST
/
api
/
lipsyncs_v2
/
{id}
/
render
curl --request POST \
  --url https://api.creatify.ai/api/lipsyncs_v2/{id}/render/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "output": "<string>",
  "video_thumbnail": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credits_used": 123,
  "progress": "<string>",
  "failed_reason": "<string>",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "webhook_url": "<string>",
  "preview": "<string>"
}

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
id
string
required
output
string | null
required

Output video

video_thumbnail
string
required

Generated Video Thumbnail URL

created_at
string
required
updated_at
string
required
credits_used
integer
required

Credits used in this api call

progress
string
required
failed_reason
string | null
required

The reason for failure, if the lipsync request failed

status
string
required

Status of the lipsync request

preview
string | null
required

Preview video

name
string | null

The name of the lipsync request.

Maximum length: 255
media_job
string | null

The media job associated with the lipsync request.

webhook_url
string | null

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

Maximum length: 200