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
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Body

​
aspect_ratio
enum<string>
required

The aspect ratio of the video

  • 16x9 - Ratio 16 9
  • 1x1 - Ratio 1 1
  • 9x16 - Ratio 9 16
Available options:
16x9,
1x1,
9x16
​
accent
string | null

The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.

​
audio
string | null

Use your own audio file url for lipsync instead of the voiceover generated by us from text input. Either audio or text is required. If both are provided, audio will be used

​
background_asset_image_url
string

The url of the background asset image

Maximum length: 1024
​
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

​
caption_style
enum<string>

The style of the captions

  • 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
​
creator
string | null

The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.

​
green_screen
boolean

When true, the background will be transparent and subtitles will not be rendered on the video. Default is false.

​
name
string | null

The name of the lipsync request.

Maximum length: 255
​
no_caption
boolean

Whether to include captions in the output video. Default is true, video without caption.

​
no_music
boolean

Whether to include background music in the output video. Default is true, video without music.

​
text
string | null

The text to be used for voiceover

Maximum length: 3600
​
webhook_url
string | null

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

Maximum length: 200

Response

201 - application/json
​
aspect_ratio
enum<string>
required

The aspect ratio of the video

  • 16x9 - Ratio 16 9
  • 1x1 - Ratio 1 1
  • 9x16 - Ratio 9 16
Available options:
16x9,
1x1,
9x16
​
audio_url
string | null
required
​
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
​
is_hidden
boolean
required

Is the video hidden in the website projects page

​
media_job
string | null
required

The media job associated with the lipsync request.

​
output
string | null
required

Output video

​
preview
string | null
required

Preview video

​
preview_audio
string | null
required

Preview audio

​
progress
string
required
​
status
string
required

Status of the lipsync request

​
updated_at
string
required
​
accent
string | null

The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.

​
background_asset_image_url
string

The url of the background asset image

Maximum length: 1024
​
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

​
caption_style
enum<string>

The style of the captions

  • 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
​
creator
string | null

The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.

​
green_screen
boolean

When true, the background will be transparent and subtitles will not be rendered on the video. Default is false.

​
name
string | null

The name of the lipsync request.

Maximum length: 255
​
no_caption
boolean

Whether to include captions in the output video. Default is true, video without caption.

​
no_music
boolean

Whether to include background music in the output video. Default is true, video without music.

​
text
string | null

The text to be used for voiceover

Maximum length: 3600
​
webhook_url
string | null

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

Maximum length: 200
Get link by idCreate a multi_avatar lipsync task