API Documentation
Link to videos
Links
Lipsyncs
Lipsyncs v2
AI Shorts
AI Editing
Avatar
Voices
Workspace
Create a lipsync v2 task
API that converts a list of texts, voices and avatars to vivid videos of many people speaking. Creating a video through this endpoint costs 5 credits for every 30 seconds.
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 jobstatus(string): The status of the job. Possible values arepending,in_queue,running,failed,donefailed_reason(string): The reason of the failure if the job failedoutput(string): The URL of the video if the job is done
Authorizations
API ID, from your settings page.
API Key, from your settings page.
Body
Type of background, can be 'image' or 'video'.
image- imagevideo- video
image, video Background URL.
Effect applied to the background image. Can be null for no effect.
imageSlideLeft- imageSlideLeftimageZoomIn- imageZoomInimageZoomOut- imageZoomOutimageWobbling- imageWobblingimageThrob- imageThrob
imageSlideLeft, imageZoomIn, imageZoomOut, imageWobbling, imageThrob Background fit to the screen.
cover- deprecated, use 'crop' insteadcrop- The entire object is cropped to fill the box. The left/right or top/bottom of the object will be cropped.contain- For image only. The entire object is scaled to fill the box, while preserving its aspect ratio. And the left/right or top/bottom of the box will be filled with blurred background.
cover, crop, contain Avatar ID, a unique identifier for the avatar.
50Type of character, only 'avatar' is supported.
avatar- avatar
avatar Style of the avatar, default is normal
circle- circlenormal- normal
circle, normal Hide avatar, default false, if set to True the avatar will be hidden.
Scale of the avatar, ranging from 0.0 to 2.0.
0 < x < 2Input text for the voice synthesis, up to 2000 characters.
2000Type of input, currently only 'text' is supported.
text- text
text Voice ID, if not provided, the default voice will be used.
50Volume of the voiceover, ranging from 0.0 to 1.0.
0 < x < 1Caption background color, hex color with an alpha channel: #RRGGBBAA.
Font family
Montserrat- MontserratJockey One- JockeyOneLilita One- LilitaOneMclaren- MclarenCorben- CorbenDela Gothic One- DelaGothicOneComfortaa- ComfortaaLuckiest Guy- LuckiestGuyQuantico- QuanticoPoppins- Poppins
Montserrat, Jockey One, Lilita One, Mclaren, Corben, Dela Gothic One, Comfortaa, Luckiest Guy, Quantico, Poppins Font size
Font style
font-bold- BOLDitalic- ITALICunderline- UNDERLINE
font-bold, italic, underline Hide caption
Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA.
Caption line height
Caption max width in px
Caption style
normal-black- NORMAL_BLACKnormal-white- NORMAL_WHITEnormal-red- NORMAL_REDnormal-blue- NORMAL_BLUEneo- NEObrick- BRICKfrenzy- FRENZYverana- VERANAmustard- MUSTARDglow- GLOWmint- MINTcoolers- COOLERSbilo- BILOtoons- TOONSdeep-blue- DEEP_BLUEmystique- MYSTIQUEcaution- CAUTIONduality- DUALITY
normal-black, normal-white, normal-red, normal-blue, neo, brick, frenzy, verana, mustard, glow, mint, coolers, bilo, toons, deep-blue, mystique, caution, duality Caption text color, hex color with an alpha channel: #RRGGBBAA.
Caption text shadow
Call To Action setting.
Blur the background of the CTA.
CTA caption.
Caption for the CTA.
200Caption background color, hex color with an alpha channel: #RRGGBBAA.
Font family
Montserrat- MontserratJockey One- JockeyOneLilita One- LilitaOneMclaren- MclarenCorben- CorbenDela Gothic One- DelaGothicOneComfortaa- ComfortaaLuckiest Guy- LuckiestGuyQuantico- QuanticoPoppins- Poppins
Montserrat, Jockey One, Lilita One, Mclaren, Corben, Dela Gothic One, Comfortaa, Luckiest Guy, Quantico, Poppins Font size
Font style
font-bold- BOLDitalic- ITALICunderline- UNDERLINE
font-bold, italic, underline Hide caption
Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA.
Line height for the caption.
Caption max width in px
Caption style
normal-black- NORMAL_BLACKnormal-white- NORMAL_WHITEnormal-red- NORMAL_REDnormal-blue- NORMAL_BLUEneo- NEObrick- BRICKfrenzy- FRENZYverana- VERANAmustard- MUSTARDglow- GLOWmint- MINTcoolers- COOLERSbilo- BILOtoons- TOONSdeep-blue- DEEP_BLUEmystique- MYSTIQUEcaution- CAUTIONduality- DUALITY
normal-black, normal-white, normal-red, normal-blue, neo, brick, frenzy, verana, mustard, glow, mint, coolers, bilo, toons, deep-blue, mystique, caution, duality Caption text color, hex color with an alpha channel: #RRGGBBAA.
Caption text shadow
CTA logo.
URL for the logo.
Scale of the logo, ranging from 0.0 to 2.0. Set to 0.0 for automatic scaling based on optimal size.
0 < x < 1Transition effect between video inputs.
Transition effect for entering the video input. Can be null for no transition.
fade- fadeleftSwipe- leftSwiperightSwipe- rightSwipetopSwipe- topSwipebottomSwipe- bottomSwipe
fade, leftSwipe, rightSwipe, topSwipe, bottomSwipe Transition effect for exiting the video input. Can be null for no transition.
fade- fadeleftSwipe- leftSwiperightSwipe- rightSwipetopSwipe- topSwipebottomSwipe- bottomSwipe
fade, leftSwipe, rightSwipe, topSwipe, bottomSwipe Transition effect between video inputs.
Transition effect for entering the video input. Can be null for no transition.
fade- fadeleftSwipe- leftSwiperightSwipe- rightSwipetopSwipe- topSwipebottomSwipe- bottomSwipe
fade, leftSwipe, rightSwipe, topSwipe, bottomSwipe Transition effect for exiting the video input. Can be null for no transition.
fade- fadeleftSwipe- leftSwiperightSwipe- rightSwipetopSwipe- topSwipebottomSwipe- bottomSwipe
fade, leftSwipe, rightSwipe, topSwipe, bottomSwipe 9x16- 9X1616x9- 16X91x1- 1X1
9x16, 16x9, 1x1 Call To Action setting to the end of video.
CTA background.
Type of background, can be 'image' or 'video'.
image- imagevideo- video
image, video Background URL.
Effect applied to the background image. Can be null for no effect.
imageSlideLeft- imageSlideLeftimageZoomIn- imageZoomInimageZoomOut- imageZoomOutimageWobbling- imageWobblingimageThrob- imageThrob
imageSlideLeft, imageZoomIn, imageZoomOut, imageWobbling, imageThrob Background fit to the screen.
cover- deprecated, use 'crop' insteadcrop- The entire object is cropped to fill the box. The left/right or top/bottom of the object will be cropped.contain- For image only. The entire object is scaled to fill the box, while preserving its aspect ratio. And the left/right or top/bottom of the box will be filled with blurred background.
cover, crop, contain Blur the background of the CTA.
CTA caption.
Caption for the CTA.
200Caption background color, hex color with an alpha channel: #RRGGBBAA.
Font family
Montserrat- MontserratJockey One- JockeyOneLilita One- LilitaOneMclaren- MclarenCorben- CorbenDela Gothic One- DelaGothicOneComfortaa- ComfortaaLuckiest Guy- LuckiestGuyQuantico- QuanticoPoppins- Poppins
Montserrat, Jockey One, Lilita One, Mclaren, Corben, Dela Gothic One, Comfortaa, Luckiest Guy, Quantico, Poppins Font size
Font style
font-bold- BOLDitalic- ITALICunderline- UNDERLINE
font-bold, italic, underline Hide caption
Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA.
Line height for the caption.
Caption max width in px
Caption style
normal-black- NORMAL_BLACKnormal-white- NORMAL_WHITEnormal-red- NORMAL_REDnormal-blue- NORMAL_BLUEneo- NEObrick- BRICKfrenzy- FRENZYverana- VERANAmustard- MUSTARDglow- GLOWmint- MINTcoolers- COOLERSbilo- BILOtoons- TOONSdeep-blue- DEEP_BLUEmystique- MYSTIQUEcaution- CAUTIONduality- DUALITY
normal-black, normal-white, normal-red, normal-blue, neo, brick, frenzy, verana, mustard, glow, mint, coolers, bilo, toons, deep-blue, mystique, caution, duality Caption text color, hex color with an alpha channel: #RRGGBBAA.
Caption text shadow
Duration of the CTA in seconds.
CTA logo.
URL for the logo.
Scale of the logo, ranging from 0.0 to 2.0. Set to 0.0 for automatic scaling based on optimal size.
0 < x < 1Transition effect between video inputs.
Transition effect for entering the video input. Can be null for no transition.
fade- fadeleftSwipe- leftSwiperightSwipe- rightSwipetopSwipe- topSwipebottomSwipe- bottomSwipe
fade, leftSwipe, rightSwipe, topSwipe, bottomSwipe Transition effect for exiting the video input. Can be null for no transition.
fade- fadeleftSwipe- leftSwiperightSwipe- rightSwipetopSwipe- topSwipebottomSwipe- bottomSwipe
fade, leftSwipe, rightSwipe, topSwipe, bottomSwipe Response
Credits used in this api call
The reason for failure, if the lipsync request failed
Output video
Preview video
Status of the lipsync request
The media job associated with the lipsync request.
The name of the lipsync request.
255The webhook URL to be called upon completion of the lipsync request
200