namestring nullable
Name of the video. Default is null.
target_platformstring
Target platform for the video. Default is 'tiktok'.
target_audiencestring nullable
Target audience for the video. Default is 'young adults'.
language'af' | 'ar' | 'as' | 'az' | 'be' | 'bg' | 'bn' | 'bs' | 'ca' | 'cb' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'es' | 'et' | 'fa' | 'fi' | 'fl' | 'fr' | 'ga' | 'gl' | 'gu' | 'ha' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'jv' | 'ka' | 'kk' | 'kn' | 'ko' | 'ky' | 'lb' | 'ln' | 'lt' | 'lv' | 'mk' | 'ml' | 'mr' | 'ms' | 'ne' | 'nl' | 'no' | 'ny' | 'pa' | 'pl' | 'ps' | 'pt' | 'ro' | 'ru' | 'sd' | 'sk' | 'sl' | 'so' | 'sr' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh'
- af - Afrikaans
- ar - Arabic
- as - Assamese
- az - Azerbaijani
- be - Belarusian
- bg - Bulgarian
- bn - Bengali
- bs - Bosnian
- ca - Catalan; Valencian
- cb - Cebuano
- cs - Czech
- cy - Welsh
- da - Danish
- de - German
- el - Greek, Modern
- en - English
- es - Spanish; Castilian
- et - Estonian
- fa - Persian
- fi - Finnish
- fl - Filipino
- fr - French
- ga - Irish
- gl - Galician
- gu - Gujarati
- ha - Hausa
- he - Hebrew (modern)
- hi - Hindi
- hr - Croatian
- hu - Hungarian
- hy - Armenian
- id - Indonesian
- is - Icelandic
- it - Italian
- ja - Japanese
- jv - Javanese
- ka - Georgian
- kk - Kazakh
- kn - Kannada
- ko - Korean
- ky - Kirghiz, Kyrgyz
- lb - Luxembourgish, Letzeburgesch
- ln - Lingala
- lt - Lithuanian
- lv - Latvian
- mk - Macedonian
- ml - Malayalam
- mr - Marathi (Marāṭhī)
- ms - Malay
- ne - Nepali
- nl - Dutch
- no - Norwegian
- ny - Chichewa; Chewa; Nyanja
- pa - Panjabi, Punjabi
- pl - Polish
- ps - Pashto, Pushto
- pt - Portuguese
- ro - Romanian, Moldavian, Moldovan
- ru - Russian
- sd - Sindhi
- sk - Slovak
- sl - Slovene
- so - Somali
- sr - Serbian
- sv - Swedish
- sw - Swahili
- ta - Tamil
- te - Telugu
- th - Thai
- tl - Tagalog
- tr - Turkish
- uk - Ukrainian
- ur - Urdu
- vi - Vietnamese
- zh - Chinese
video_length15 | 30 | 45 | 60
- 15 - 15
- 30 - 30
- 45 - 45
- 60 - 60
script_style'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'
- 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
visual_style'AvatarBubbleTemplate' | 'DramaticTemplate' | 'DynamicGreenScreenEffect' | 'DynamicProductTemplate' | 'DynamicResponseBubbleTemplate' | 'EnhancedVanillaTemplate' | 'FeatureHighlightTemplate' | 'FullScreenTemplate' | 'FullScreenV2Template' | 'GreenScreenEffectTemplate' | 'MotionCardsTemplate' | 'OverCardsTemplate' | 'QuickFrameTemplate' | 'QuickTransitionTemplate' | 'ScribbleTemplate' | 'SideBySideTemplate' | 'SimpleAvatarOverlayTemplate' | 'TopBottomTemplate' | 'TwitterFrameTemplate' | 'VanillaTemplate' | 'VlogTemplate' | 'LegoVisualEmotional' | 'LegoVisualCutePets' | 'LegoVisualAvatarFocusIntro' | 'LegoScriptNegativeHook' | 'LegoScriptNumberOneHook' | 'LegoScriptEverWonderHook' | 'LegoScriptSecretHook' | 'LegoScriptWhatHappensHook' | 'LegoScriptAnyoneElseHook' | 'LegoScriptAmazedHook' | 'LegoScript2025Hook' | 'LegoScriptHateMeHook' | 'LegoScriptResponseBubbleTextOverlay' | 'LegoScriptHeyAlgorithmHook' | 'LegoScriptCannotBelieveHook' | 'LegoScriptFinallyConfidentHook' | 'LegoScriptPremiumFeelingHook' | 'LegoScriptFirstTimeFullHook' | 'LegoScriptLongLineReasonHook' | 'LegoScriptMissingOutAlertHook' | 'LegoScriptBetterTodayVersionHook' | 'LegoScriptBigHappeningHook' | 'LegoScriptPriceDropRegretHook' | 'LegoScriptGroupBuyFrustrationHook' | 'LegoScriptStopAffordExcuseHook' | 'LegoScriptLifeTooShortDiscountHook' | 'LegoScriptHugePriceDropRushHook' | 'LegoScriptPriceCouldGoLowerHook' | 'LegoScriptStillFullPriceHook' | 'LegoScriptSecretDiscountShareHook' | 'LegoScriptVoucherSavingsAlertHook' | 'LegoScriptCouponDiscoveryRegretHook' | 'LegoScriptBestDealEverHook'
override_avatarstring nullable
Override avatar for the video. Default is null.
override_avatar_by_imagestring uri nullable
Override avatar by providing an avatar image URL. Default is null.
override_voicestring nullable
Override voice for the video. Default is null.
override_scriptstring nullable
Override script for the video. Default is null.
background_music_urlstring uri nullable
Background music URL for the video. Default is null, video will use random music.
background_music_volumenumber double nullable
Volume of the background music, ranging from 0.0 to 1.0. Default is null, video will use default music volume of visual_style.
voiceover_volumenumber double nullable
Volume of the voiceover, ranging from 0.0 to 1.0. Default is null, video will use default voiceover volume of visual_style.
webhook_urlstring uri nullable
Webhook URL for status updates. Default is null.
linkstring uuid required
Link associated with the video.
media_jobstring uuid nullable required
Media job associated with the video. Default is null.
failed_reasonstring nullable required
Reason for failure. Default is null.
is_hiddenboolean required
video_outputstring uri required
video_thumbnailstring uri required
Generated Video Thumbnail URL
credits_usednumber required
Credits used in this API call
durationinteger required
Duration of the video in seconds
no_background_musicboolean
No background music for the video. Default is false, video with background music.
no_captionboolean
No caption for the video. Default is false, video with caption.
no_emotionboolean
No emotion for the video. Default is false, video with emotion.
no_ctaboolean
No call to action for the video. Default is false, video with call to action.
no_stock_brollboolean
No stock broll for the video. Default is false, video with stock broll.
previewstring uri required
editor_urlstring uri required
Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled.
caption_offset_xstring decimal nullable
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_ystring decimal nullable
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.
model_version'standard' | 'aurora_v1' | 'aurora_v1_fast' | 'boreal' | 'aurora_v2'
- standard - Standard
- aurora_v1 - Aurora v1
- aurora_v1_fast - Aurora v1 Fast
- boreal - Boreal
- aurora_v2 - Aurora v2
visual_stylesVisualStylesEnum[] required
aspect_ratiosAspectRatiosEnum[] nullable