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.

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:

"https://app.creatify.ai/preview?layout=videos/20241024/f0c1e1f1-be05-48e0-91d8-3d26ed633d5b.json"

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

name · string | null

The name of the lipsync request.

Maximum length: 255

text · string | null

The text to be used for voiceover

Maximum length: 8000

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

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.

webhook_url · string | null

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

Maximum length: 200

accent · string | null

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

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.

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

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

200 - application/json

id · string · required

output · string | null · required

Output video

video_thumbnail · string · required

Generated Video Thumbnail URL

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

created_at · string · required

updated_at · string · required

credits_used · integer · required

Credits used in this api call

progress · string · required

failed_reason · string | null · required

The reason for failure, if the lipsync request failed

media_job · string | null · required

The media job associated with the lipsync request.

status · string · required

Status of the lipsync request

is_hidden · boolean · required

Is the video hidden in the website projects page

audio_url · string | null · required

preview · string | null · required

Preview video

preview_audio · string | null · required

Preview audio

name · string | null

The name of the lipsync request.

Maximum length: 255

text · string | null

The text to be used for voiceover

Maximum length: 8000

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.

webhook_url · string | null

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

Maximum length: 200

accent · string | null

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

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.

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

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