POST
/
api
/
lipsyncs_v2
/

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
headerrequired

API ID, from your settings page.

X-API-KEY
string
headerrequired

API Key, from your settings page.

Body

video_inputs
object[]
required
aspect_ratio
enum<string>
default: 9x16
  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
Available options:
9x16,
16x9,
1x1
background_music
object

Background music settings.

webhook_url
string

Response

201 - application/json
id
string
required
output
string | null
required
created_at
string
required
updated_at
string
required
progress
number
required
failed_reason
string | null
required
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
preview
string | null
required

Preview video

name
string | null
Maximum length: 255
media_job
string | null
webhook_url
string | null
Maximum length: 200