Generate a list of Previews Async

This endpoint generates a list of preview videos asynchronously before rendering the final video. This endpoint costs 1 credit for every 30 seconds.

About previews Field in the Response

The previews field provides a list of urls to preview videos. This url 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 previews field in the response will look like this:

[
    {
        "media_job": "4bb66ccf-5f73-401a-8405-d4b29910a059",
        "url": "https://video.creatify.ai/preview?layout=videos/20240808/abd7ac2e-471a-4f0c-b2b2-a4e6580c61f9.json"
    }
]

About Request Data Structure of Webhook

If the ‘webhook_url’ is passed in the parameters, we will initiate a POST request to the webhook_url when the previews generation succeeds or fails, with the following content:

{
    "id": "e3e23f91-6101-44c6-a1b1-fa14408287b8",
    "status": "pending",
    "failed_reason": null,
    "previews": [
        {
            "media_job": "4bb66ccf-5f73-401a-8405-d4b29910a059",
            "url": "https://video.creatify.ai/preview?layout=videos/20240808/abd7ac2e-471a-4f0c-b2b2-a4e6580c61f9.json"
        }
    ],
}

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
• previews (list[dict]): The URL of the video if the job is done

Note: We might send multiple requests for status changes.

About override_avatar parameter

When using ‘create video from link’ API, if the ‘override_avatar’ (avatar_id is passed in the parameters, we will use it as the avatar of the video. If the ‘override_avatar’ is not passed, we will use the matched avatar for the video.

avatar_id is the unique identifier of an avatar. You can get the avatar_id by calling the Get avatar endpoint.

About override_voice parameter

When using ‘create video from link’ API, if the ‘override_voice’ is passed in the parameters, we will use it for the voiceover of the video. If the ‘override_voice’ is not passed, we’ll use the matched voice (from the avatar) for the video.

voice_id is the unique identifier of the voice. You can get the voice_id by calling the Get voices interface.

Tips: foreach voice has multiple accents, you can choose one from the accents as the voice of the video.

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

link · string<uuid> · required

Link associated with the video.

visual_styles · enum<string>[] · required

Minimum length: 1

Show child attributes

name · string | null

Name of the video. Default is null.

Maximum length: 255

target_platform · string

Target platform for the video. Default is 'tiktok'.

Maximum length: 255

target_audience · string | null

Target audience for the video. Default is 'young adults'.

language · enum<string>

Language of the video. Default is 'en'.

• ar - Arabic
• bg - Bulgarian
• cs - Czech
• da - Danish
• de - German
• el - Greek, Modern
• en - English
• es - Spanish; Castilian
• fi - Finnish
• fr - French
• hi - Hindi
• hr - Croatian
• id - Indonesian
• it - Italian
• ja - Japanese
• ko - Korean
• ms - Malay
• nl - Dutch
• pl - Polish
• pt - Portuguese
• ro - Romanian, Moldavian, Moldovan
• ru - Russian
• sk - Slovak
• sv - Swedish
• ta - Tamil
• tl - Tagalog
• tr - Turkish
• uk - Ukrainian
• zh - Chinese

Available options:

ar,

bg,

cs,

da,

de,

el,

en,

es,

fi,

fr,

hi,

hr,

id,

it,

ja,

ko,

ms,

nl,

pl,

pt,

ro,

ru,

sk,

sv,

ta,

tl,

tr,

uk,

zh

video_length · enum<integer>

Length of the video in seconds. Default is 15.

• 15 - 15
• 30 - 30
• 60 - 60

Available options:

15,

30,

60

aspect_ratio

• 9x16 - 9X16
• 16x9 - 16X9
• 1x1 - 1X1

Available options:

9x16,

16x9,

1x1

script_style · enum<string>

Script style of the video. Default is DiscoveryWriter.

• BenefitsV2 - Benefits
• BrandStoryV2 - Brand Story
• CallToActionV2 - Call To Action
• DiscoveryWriter - Discovery
• DontWorryWriter - Don't Worry
• EmotionalWriter - Emotional
• GenzWriter - Gen Z
• HowToV2 - How To
• LetMeShowYouWriter - Let Me Show You
• MotivationalWriter - Motivational
• ProblemSolutionV2 - Problem Solution
• ProblemSolutionWriter - Problem-Solution
• ProductHighlightsV2 - Product Highlights
• ProductLifestyleV2 - Product Lifestyle
• ResponseBubbleWriter - Response Bubble
• SpecialOffersV2 - Special Offers
• StoryTimeWriter - Storytime
• ThreeReasonsWriter - 3 Reasons Why
• TrendingTopicsV2 - Trending Topics
• NegativeHook - Don’t Use This If You Want...
• NumberOneHook - The #1 Hack You Need
• EverWonderHook - Ever Wonder Why?
• SecretHook - Wish I Could Keep This Secret
• WhatHappensHook - What Happens If You Try This?
• AnyoneElseHook - That One Thing We All Have
• AmazedHook - Still Amazed by This
• 2025Hook - Hack 2025 Like This
• HateMeHook - They’ll Hate Me for This
• ResponseBubbleTextOverlay - Response bubble
• HeyAlgorithmHook - Hey Algorithm
• CannotBelieveHook - Cannot Believe This
• FinallyConfidentHook - Finally Confident
• PremiumFeelingHook - Premium Feeling
• FirstTimeFullHook - First Time Full
• LongLineReasonHook - Long Line Reason
• MissingOutAlertHook - Missing Out Alert
• BetterTodayVersionHook - Better Today Version
• BigHappeningHook - Big Happening
• PriceDropRegretHook - Price Drop Regret
• GroupBuyFrustrationHook - Group Buy Frustration
• StopAffordExcuseHook - Stop Afford Excuse
• LifeTooShortDiscountHook - Life Too Short Discount
• HugePriceDropRushHook - Huge Price Drop Rush
• PriceCouldGoLowerHook - Price Could Go Lower
• StillFullPriceHook - Still Full Price
• SecretDiscountShareHook - Secret Discount Share
• VoucherSavingsAlertHook - Voucher Savings Alert
• CouponDiscoveryRegretHook - Coupon Discovery Regret
• BestDealEverHook - Best Deal Ever
• DIY - DIY

Available options:

BenefitsV2,

BrandStoryV2,

CallToActionV2,

DiscoveryWriter,

DontWorryWriter,

EmotionalWriter,

GenzWriter,

HowToV2,

LetMeShowYouWriter,

MotivationalWriter,

ProblemSolutionV2,

ProblemSolutionWriter,

ProductHighlightsV2,

ProductLifestyleV2,

ResponseBubbleWriter,

SpecialOffersV2,

StoryTimeWriter,

ThreeReasonsWriter,

TrendingTopicsV2,

NegativeHook,

NumberOneHook,

EverWonderHook,

SecretHook,

WhatHappensHook,

AnyoneElseHook,

AmazedHook,

2025Hook,

HateMeHook,

ResponseBubbleTextOverlay,

HeyAlgorithmHook,

CannotBelieveHook,

FinallyConfidentHook,

PremiumFeelingHook,

FirstTimeFullHook,

LongLineReasonHook,

MissingOutAlertHook,

BetterTodayVersionHook,

BigHappeningHook,

PriceDropRegretHook,

GroupBuyFrustrationHook,

StopAffordExcuseHook,

LifeTooShortDiscountHook,

HugePriceDropRushHook,

PriceCouldGoLowerHook,

StillFullPriceHook,

SecretDiscountShareHook,

VoucherSavingsAlertHook,

CouponDiscoveryRegretHook,

BestDealEverHook,

DIY

override_avatar · string | null

Override avatar for the video. Default is null.

Maximum length: 255

override_voice · string | null

Override voice for the video. Default is null.

Maximum length: 255

override_script · string | null

Override script for the video. Default is null.

background_music_url · string<uri> | null

Background music URL for the video. Default is null, video will use random music.

Maximum length: 255

background_music_volume · number | null

Volume of the background music, ranging from 0.0 to 1.0. Default is null, video will use default music volume of visual_style.

Required range: 0 <= x <= 1

voiceover_volume · number | null

Volume of the voiceover, ranging from 0.0 to 1.0. Default is null, video will use default voiceover volume of visual_style.

Required range: 0 <= x <= 1

webhook_url · string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200

no_background_music · boolean

No background music for the video. Default is false, video with background music.

no_caption · boolean

No caption for the video. Default is false, video with caption.

no_emotion · boolean

No emotion for the video. Default is false, video with emotion.

no_cta · boolean

No call to action for the video. Default is false, video with call to action.

no_stock_broll · boolean

No stock broll for the video. Default is false, video with stock broll.

caption_style

Deprecated, use style in caption_setting instead. Caption style for the video. Default is 'normal-black'.

• 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
• comic-shadow - COMIC_SHADOW
• clean-bold - CLEAN_BOLD
• soft-pill - SOFT_PILL
• underline-bold - UNDERLINE_BOLD
• classic-duo - CLASSIC_DUO
• hand-script - HAND_SCRIPT
• button-glow - BUTTON_GLOW
• emboss-outline - EMBOSS_OUTLINE
• standard-bold - STANDARD_BOLD
• outlined-text - OUTLINED_TEXT
• quiet-serif - QUIET_SERIF
• editorial-clean - EDITORIAL_CLEAN
• shout-block - SHOUT_BLOCK
• word-flash - WORD_FLASH
• promo-punch - PROMO_PUNCH
• light-word - LIGHT_WORD
• tagline-bold - TAGLINE_BOLD
• glow-speak - GLOW_SPEAK
• black-block - BLACK_BLOCK

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,

comic-shadow,

clean-bold,

soft-pill,

underline-bold,

classic-duo,

hand-script,

button-glow,

emboss-outline,

standard-bold,

outlined-text,

quiet-serif,

editorial-clean,

shout-block,

word-flash,

promo-punch,

light-word,

tagline-bold,

glow-speak,

black-block

caption_offset_x · string<decimal> | null

Deprecated, use offset in caption_setting instead. Caption offset x is horizontally relative to the center of the canvas in percentage, range from -0.5 to 0.5. Default is null, video with default caption position of visual_style.

caption_offset_y · string<decimal> | null

Deprecated, use offset in caption_setting instead. Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5. Default is null, video with default caption position of visual_style.

caption_setting · object

Caption setting, default null and default caption setting will be used

Show child attributes

model_version · enum<string>

Model version for the avatar, 'standard', 'aurora_v1' or 'aurora_v1_fast'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 20 credits per 15 seconds video, and Aurora_v1_fast renders faster with lower quality for 10 credits per 15 seconds video.

• standard - Standard
• aurora_v1 - Aurora v1
• aurora_v1_fast - Aurora v1 Fast

Available options:

standard,

aurora_v1,

aurora_v1_fast

aspect_ratios · enum<string>[] | null

Show child attributes

Response

200 - application/json

id · string<uuid> · required

link · string<uuid> · required

Link associated with the video.

media_job · string<uuid> | null · required

Media job associated with the video. Default is null.

status · string · required

failed_reason · string | null · required

Reason for failure. Default is null.

is_hidden · boolean · required

video_output · string<uri> · required

Generated Video URL

video_thumbnail · string<uri> · required

Generated Video Thumbnail URL

outputs · object[] · required

List of outputs

Show child attributes

credits_used · integer · required

Credits used in this API call

duration · integer · required

Duration of the video in seconds

progress · string · required

preview · string<uri> · required

Preview URL

previews · object[] · required

List of previews

Show child attributes

editor_url · string<uri> · required

Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled.

visual_styles · enum<string>[] · required

Minimum length: 1

Show child attributes

name · string | null

Name of the video. Default is null.

Maximum length: 255

target_platform · string

Target platform for the video. Default is 'tiktok'.

Maximum length: 255

target_audience · string | null

Target audience for the video. Default is 'young adults'.

language · enum<string>

Language of the video. Default is 'en'.

• ar - Arabic
• bg - Bulgarian
• cs - Czech
• da - Danish
• de - German
• el - Greek, Modern
• en - English
• es - Spanish; Castilian
• fi - Finnish
• fr - French
• hi - Hindi
• hr - Croatian
• id - Indonesian
• it - Italian
• ja - Japanese
• ko - Korean
• ms - Malay
• nl - Dutch
• pl - Polish
• pt - Portuguese
• ro - Romanian, Moldavian, Moldovan
• ru - Russian
• sk - Slovak
• sv - Swedish
• ta - Tamil
• tl - Tagalog
• tr - Turkish
• uk - Ukrainian
• zh - Chinese

Available options:

ar,

bg,

cs,

da,

de,

el,

en,

es,

fi,

fr,

hi,

hr,

id,

it,

ja,

ko,

ms,

nl,

pl,

pt,

ro,

ru,

sk,

sv,

ta,

tl,

tr,

uk,

zh

video_length · enum<integer>

Length of the video in seconds. Default is 15.

• 15 - 15
• 30 - 30
• 60 - 60

Available options:

15,

30,

60

aspect_ratio

• 9x16 - 9X16
• 16x9 - 16X9
• 1x1 - 1X1

Available options:

9x16,

16x9,

1x1

script_style · enum<string>

Script style of the video. Default is DiscoveryWriter.

• BenefitsV2 - Benefits
• BrandStoryV2 - Brand Story
• CallToActionV2 - Call To Action
• DiscoveryWriter - Discovery
• DontWorryWriter - Don't Worry
• EmotionalWriter - Emotional
• GenzWriter - Gen Z
• HowToV2 - How To
• LetMeShowYouWriter - Let Me Show You
• MotivationalWriter - Motivational
• ProblemSolutionV2 - Problem Solution
• ProblemSolutionWriter - Problem-Solution
• ProductHighlightsV2 - Product Highlights
• ProductLifestyleV2 - Product Lifestyle
• ResponseBubbleWriter - Response Bubble
• SpecialOffersV2 - Special Offers
• StoryTimeWriter - Storytime
• ThreeReasonsWriter - 3 Reasons Why
• TrendingTopicsV2 - Trending Topics
• NegativeHook - Don’t Use This If You Want...
• NumberOneHook - The #1 Hack You Need
• EverWonderHook - Ever Wonder Why?
• SecretHook - Wish I Could Keep This Secret
• WhatHappensHook - What Happens If You Try This?
• AnyoneElseHook - That One Thing We All Have
• AmazedHook - Still Amazed by This
• 2025Hook - Hack 2025 Like This
• HateMeHook - They’ll Hate Me for This
• ResponseBubbleTextOverlay - Response bubble
• HeyAlgorithmHook - Hey Algorithm
• CannotBelieveHook - Cannot Believe This
• FinallyConfidentHook - Finally Confident
• PremiumFeelingHook - Premium Feeling
• FirstTimeFullHook - First Time Full
• LongLineReasonHook - Long Line Reason
• MissingOutAlertHook - Missing Out Alert
• BetterTodayVersionHook - Better Today Version
• BigHappeningHook - Big Happening
• PriceDropRegretHook - Price Drop Regret
• GroupBuyFrustrationHook - Group Buy Frustration
• StopAffordExcuseHook - Stop Afford Excuse
• LifeTooShortDiscountHook - Life Too Short Discount
• HugePriceDropRushHook - Huge Price Drop Rush
• PriceCouldGoLowerHook - Price Could Go Lower
• StillFullPriceHook - Still Full Price
• SecretDiscountShareHook - Secret Discount Share
• VoucherSavingsAlertHook - Voucher Savings Alert
• CouponDiscoveryRegretHook - Coupon Discovery Regret
• BestDealEverHook - Best Deal Ever
• DIY - DIY

Available options:

BenefitsV2,

BrandStoryV2,

CallToActionV2,

DiscoveryWriter,

DontWorryWriter,

EmotionalWriter,

GenzWriter,

HowToV2,

LetMeShowYouWriter,

MotivationalWriter,

ProblemSolutionV2,

ProblemSolutionWriter,

ProductHighlightsV2,

ProductLifestyleV2,

ResponseBubbleWriter,

SpecialOffersV2,

StoryTimeWriter,

ThreeReasonsWriter,

TrendingTopicsV2,

NegativeHook,

NumberOneHook,

EverWonderHook,

SecretHook,

WhatHappensHook,

AnyoneElseHook,

AmazedHook,

2025Hook,

HateMeHook,

ResponseBubbleTextOverlay,

HeyAlgorithmHook,

CannotBelieveHook,

FinallyConfidentHook,

PremiumFeelingHook,

FirstTimeFullHook,

LongLineReasonHook,

MissingOutAlertHook,

BetterTodayVersionHook,

BigHappeningHook,

PriceDropRegretHook,

GroupBuyFrustrationHook,

StopAffordExcuseHook,

LifeTooShortDiscountHook,

HugePriceDropRushHook,

PriceCouldGoLowerHook,

StillFullPriceHook,

SecretDiscountShareHook,

VoucherSavingsAlertHook,

CouponDiscoveryRegretHook,

BestDealEverHook,

DIY

override_avatar · string | null

Override avatar for the video. Default is null.

Maximum length: 255

override_voice · string | null

Override voice for the video. Default is null.

Maximum length: 255

override_script · string | null

Override script for the video. Default is null.

background_music_url · string<uri> | null

Background music URL for the video. Default is null, video will use random music.

Maximum length: 255

background_music_volume · number | null

Volume of the background music, ranging from 0.0 to 1.0. Default is null, video will use default music volume of visual_style.

Required range: 0 <= x <= 1

voiceover_volume · number | null

Volume of the voiceover, ranging from 0.0 to 1.0. Default is null, video will use default voiceover volume of visual_style.

Required range: 0 <= x <= 1

webhook_url · string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200

no_background_music · boolean

No background music for the video. Default is false, video with background music.

no_caption · boolean

No caption for the video. Default is false, video with caption.

no_emotion · boolean

No emotion for the video. Default is false, video with emotion.

no_cta · boolean

No call to action for the video. Default is false, video with call to action.

no_stock_broll · boolean

No stock broll for the video. Default is false, video with stock broll.

caption_style

Deprecated, use style in caption_setting instead. Caption style for the video. Default is 'normal-black'.

• 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
• comic-shadow - COMIC_SHADOW
• clean-bold - CLEAN_BOLD
• soft-pill - SOFT_PILL
• underline-bold - UNDERLINE_BOLD
• classic-duo - CLASSIC_DUO
• hand-script - HAND_SCRIPT
• button-glow - BUTTON_GLOW
• emboss-outline - EMBOSS_OUTLINE
• standard-bold - STANDARD_BOLD
• outlined-text - OUTLINED_TEXT
• quiet-serif - QUIET_SERIF
• editorial-clean - EDITORIAL_CLEAN
• shout-block - SHOUT_BLOCK
• word-flash - WORD_FLASH
• promo-punch - PROMO_PUNCH
• light-word - LIGHT_WORD
• tagline-bold - TAGLINE_BOLD
• glow-speak - GLOW_SPEAK
• black-block - BLACK_BLOCK

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,

comic-shadow,

clean-bold,

soft-pill,

underline-bold,

classic-duo,

hand-script,

button-glow,

emboss-outline,

standard-bold,

outlined-text,

quiet-serif,

editorial-clean,

shout-block,

word-flash,

promo-punch,

light-word,

tagline-bold,

glow-speak,

black-block

caption_offset_x · string<decimal> | null

Deprecated, use offset in caption_setting instead. Caption offset x is horizontally relative to the center of the canvas in percentage, range from -0.5 to 0.5. Default is null, video with default caption position of visual_style.

caption_offset_y · string<decimal> | null

Deprecated, use offset in caption_setting instead. Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5. Default is null, video with default caption position of visual_style.

caption_setting · object

Caption setting, default null and default caption setting will be used

Show child attributes

model_version · enum<string>

Model version for the avatar, 'standard', 'aurora_v1' or 'aurora_v1_fast'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 20 credits per 15 seconds video, and Aurora_v1_fast renders faster with lower quality for 10 credits per 15 seconds video.

• standard - Standard
• aurora_v1 - Aurora v1
• aurora_v1_fast - Aurora v1 Fast

Available options:

standard,

aurora_v1,

aurora_v1_fast

aspect_ratios · enum<string>[] | null

Show child attributes