POST
/
api
/
lipsyncs
/

​
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

aspect_ratio
enum<string>
required
  • 16x9 - Ratio 16 9
  • 1x1 - Ratio 1 1
  • 9x16 - Ratio 9 16
Available options:
16x9,
1x1,
9x16
name
string | null
Maximum length: 255
text
string | null
Maximum length: 3600
audio
string | null
creator
string | null
green_screen
boolean

default to false, when true the background will be transparent and subtitles will not be rendered on the video

webhook_url
string | null
Maximum length: 200
accent
string | null
no_caption
boolean
no_music
boolean
caption_style
enum<string>
  • normal-black - NORMAL_BLACK
  • normal-white - NORMAL_WHITE
  • normal-red - NORMAL_RED
  • normal-blue - NORMAL_BLUE
  • neo - NEO
  • brick - BRICK
  • frenzy - FRENZY
  • verana - VERANA
  • mustard - MUSTARD
  • glow - GLOW
  • mint - MINT
  • coolers - COOLERS
  • bilo - BILO
  • toons - TOONS
  • deep-blue - DEEP_BLUE
  • mystique - MYSTIQUE
  • caution - CAUTION
  • duality - DUALITY
Available options:
normal-black,
normal-white,
normal-red,
normal-blue,
neo,
brick,
frenzy,
verana,
mustard,
glow,
mint,
coolers,
bilo,
toons,
deep-blue,
mystique,
caution,
duality
caption_position
enum<string>

Position of the caption, only center is supported for now

  • center - Center
Available options:
center
caption_offset_x
string

Caption offset x is horizontaly relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to 0

caption_offset_y
string

Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to -0.4, which is 40% below center

background_asset_image_url
string

The url of the background asset image

Maximum length: 1024

Response

201 - application/json
id
string
required
output
string | null
required
aspect_ratio
enum<string>
required
  • 16x9 - Ratio 16 9
  • 1x1 - Ratio 1 1
  • 9x16 - Ratio 9 16
Available options:
16x9,
1x1,
9x16
created_at
string
required
updated_at
string
required
progress
number
required
failed_reason
string | null
required
media_job
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
is_hidden
boolean
required
audio_url
string | null
required
preview
string | null
required

Preview video

preview_audio
string | null
required

Preview audio

name
string | null
Maximum length: 255
text
string | null
Maximum length: 3600
creator
string | null
green_screen
boolean

default to false, when true the background will be transparent and subtitles will not be rendered on the video

webhook_url
string | null
Maximum length: 200
accent
string | null
no_caption
boolean
no_music
boolean
caption_style
enum<string>
  • normal-black - NORMAL_BLACK
  • normal-white - NORMAL_WHITE
  • normal-red - NORMAL_RED
  • normal-blue - NORMAL_BLUE
  • neo - NEO
  • brick - BRICK
  • frenzy - FRENZY
  • verana - VERANA
  • mustard - MUSTARD
  • glow - GLOW
  • mint - MINT
  • coolers - COOLERS
  • bilo - BILO
  • toons - TOONS
  • deep-blue - DEEP_BLUE
  • mystique - MYSTIQUE
  • caution - CAUTION
  • duality - DUALITY
Available options:
normal-black,
normal-white,
normal-red,
normal-blue,
neo,
brick,
frenzy,
verana,
mustard,
glow,
mint,
coolers,
bilo,
toons,
deep-blue,
mystique,
caution,
duality
caption_position
enum<string>

Position of the caption, only center is supported for now

  • center - Center
Available options:
center
caption_offset_x
string

Caption offset x is horizontaly relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to 0

caption_offset_y
string

Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to -0.4, which is 40% below center

background_asset_image_url
string

The url of the background asset image

Maximum length: 1024
Get link by idCreate a lipsync_v2 task