Lipsyncs
Generate Preivew of lipsync
Lipsyncs
Generate Preivew of lipsync
This endpoint generates a preiview of lipsync video before redering the final video. Generating a video preview through this endpoint costs 1 credit for every 30 seconds.
POST
About preview Field in the Response
The preview field provides a link to preview the video. This link allows you to preview the video before rendering it, you can put it in an iframe to show the video in your application. Example: The preview field in the response will look like this:
Authorizations
API ID, from your settings page.
API Key, from your settings page.
Body
The aspect ratio of the video
16x9- Ratio 16 91x1- Ratio 1 19x16- Ratio 9 16
Available options:
16x9, 1x1, 9x16 The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.
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
The url of the background asset image
Maximum length:
1024Caption 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 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
The style of the captions
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
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 The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.
When true, the background will be transparent and subtitles will not be rendered on the video. Default is false.
The name of the lipsync request.
Maximum length:
255Whether to include captions in the output video. Default is true, video without caption.
Whether to include background music in the output video. Default is true, video without music.
The text to be used for voiceover
Maximum length:
3600The webhook URL to be called upon completion of the lipsync request
Maximum length:
200Response
200 - application/json
The aspect ratio of the video
16x9- Ratio 16 91x1- Ratio 1 19x16- Ratio 9 16
Available options:
16x9, 1x1, 9x16 Credits used in this api call
The reason for failure, if the lipsync request failed
Is the video hidden in the website projects page
The media job associated with the lipsync request.
Output video
Preview video
Preview audio
Status of the lipsync request
The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.
The url of the background asset image
Maximum length:
1024Caption 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 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
The style of the captions
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
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 The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.
When true, the background will be transparent and subtitles will not be rendered on the video. Default is false.
The name of the lipsync request.
Maximum length:
255Whether to include captions in the output video. Default is true, video without caption.
Whether to include background music in the output video. Default is true, video without music.
The text to be used for voiceover
Maximum length:
3600The webhook URL to be called upon completion of the lipsync request
Maximum length:
200