--- title: "POST /api/lipsyncs_v2/preview/" method: POST path: "/api/lipsyncs_v2/preview/" tags: ["lipsyncs_v2"] --- # POST /api/lipsyncs_v2/preview/ `POST /api/lipsyncs_v2/preview/` This endpoint generates the preview of a lipsync v2 video. ## Request body - VideoInputs - `video_inputs` VideoInput[], required - `character` Character, required - `type` 'avatar', required — * `avatar` - avatar - `avatar_id` string, required — Avatar ID, a unique identifier for the avatar. - `scale` number, double — Scale of the avatar, ranging from 0.0 to 2.0. - `avatar_style` 'circle' | 'normal' — * `circle` - circle * `normal` - normal - `offset` Offset, required - `x` number, double — X offset for the avatar. - `y` number, double — Y offset for the avatar. - `hidden` boolean — Hide avatar, default false, if set to True the avatar will be hidden. - `voice` Voice, required - `type` 'text' | 'silence', required — * `text` - text * `silence` - silence - `input_text` string, nullable — Input text for the voice synthesis, up to 2000 characters. Required when type='text'. - `voice_id` string, nullable — Voice ID, if not provided, the default voice will be used. Only applies to type='text'. - `duration` number, double, nullable — Duration of silence in seconds, value ranges from 1.0 to 100.0. Required when type='silence'. If background is video and duration is not provided, video duration will be used. - `volume` number, double — Volume of the voiceover, ranging from 0.0 to 1.0. Only applies to type='text'. - `model` union — Override the TTS model for this voice. Default (null) uses the model resolved from the voice record. Use 'v3' to enable inline emotion / delivery tags such as [lighthearted], [emphasized], [slows down]. Only applies to type='text'. * `v2` - V2 * `v3` - V3 - 'v2' | 'v3' — * `v2` - V2 * `v3` - V3 - unknown - `caption_setting` Caption - `style` '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' | 'zoom-punch' — * `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 * `zoom-punch` - ZOOM_PUNCH - `offset` CaptionOffset - `x` number, double — X offset for the caption. - `y` number, double — Y offset for the caption. - `font_family` 'Montserrat' | 'Jockey One' | 'Lilita One' | 'Mclaren' | 'Corben' | 'Dela Gothic One' | 'Comfortaa' | 'Luckiest Guy' | 'Quantico' | 'Poppins' — * `Montserrat` - Montserrat * `Jockey One` - JockeyOne * `Lilita One` - LilitaOne * `Mclaren` - Mclaren * `Corben` - Corben * `Dela Gothic One` - DelaGothicOne * `Comfortaa` - Comfortaa * `Luckiest Guy` - LuckiestGuy * `Quantico` - Quantico * `Poppins` - Poppins - `font_size` integer — Font size - `font_style` union — Font style * `font-bold` - BOLD * `italic` - ITALIC * `underline` - UNDERLINE - 'font-bold' | 'italic' | 'underline' — * `font-bold` - BOLD * `italic` - ITALIC * `underline` - UNDERLINE - unknown - `background_color` string, nullable — Caption background color, hex color with an alpha channel: #RRGGBBAA. - `text_color` string, nullable — Caption text color, hex color with an alpha channel: #RRGGBBAA. - `highlight_text_color` string, nullable — Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA. - `max_width` integer, nullable — Caption max width in px - `line_height` number, double, nullable — Caption line height - `text_shadow` string, nullable — Caption text shadow - `hidden` boolean — Hide caption - `override_visual_style` boolean — If true, these caption settings will override the visual style's default caption settings. Only effective when visual_style is set. - `background` Background, required - `type` 'image' | 'video', required — * `image` - image * `video` - video - `url` string, uri, required — Background URL. - `fit` 'cover' | 'crop' | 'contain' — * `cover` - deprecated, use 'crop' instead * `crop` - The entire object is cropped to fill the box. The left/right or top/bottom of the object will be cropped. * `contain` - 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. - `effect` union — Effect applied to the background image. Can be null for no effect. * `imageSlideLeft` - imageSlideLeft * `imageZoomIn` - imageZoomIn * `imageZoomOut` - imageZoomOut * `imageWobbling` - imageWobbling * `imageThrob` - imageThrob - 'imageSlideLeft' | 'imageZoomIn' | 'imageZoomOut' | 'imageWobbling' | 'imageThrob' — * `imageSlideLeft` - imageSlideLeft * `imageZoomIn` - imageZoomIn * `imageZoomOut` - imageZoomOut * `imageWobbling` - imageWobbling * `imageThrob` - imageThrob - unknown - `transition_effect` Transition - `transition_in` union — Transition effect for entering the video input. Can be null for no transition. * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - 'fade' | 'leftSwipe' | 'rightSwipe' | 'topSwipe' | 'bottomSwipe' — * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - unknown - `transition_out` union — Transition effect for exiting the video input. Can be null for no transition. * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - 'fade' | 'leftSwipe' | 'rightSwipe' | 'topSwipe' | 'bottomSwipe' — * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - unknown - `visual_style` union — Defines the visual style for this section of the video. If set, it will override character, background, and caption position and style settings. Default is null, existing settings will be used. * `FullAvatar` - FullAvatar (Applicable to aspect_ratio 9x16, 16x9, 1x1) ![FullAvatar](https://dpbavq092lwjh.cloudfront.net/visual_styles/FullAvatar.png) * `GreenScreenEffect` - GreenScreenEffect (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![GreenScreenEffect](https://dpbavq092lwjh.cloudfront.net/visual_styles/GreenScreenEffect.png) * `FullAvatarScreenProductOverlay` - FullAvatarScreenProductOverlay (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![FullAvatarScreenProductOverlay](https://dpbavq092lwjh.cloudfront.net/visual_styles/FullAvatarScreenProductOverlay.png) * `UpAndDown` - UpAndDown (Applicable to aspect_ratio 1x1, 9x16) ![UpAndDown](https://dpbavq092lwjh.cloudfront.net/visual_styles/UpAndDown.png) * `SideBySide` - SideBySide (Applicable to aspect_ratio 1x1, 16x9) ![SideBySide](https://dpbavq092lwjh.cloudfront.net/visual_styles/SideBySide.png) * `FullProduct` - FullProduct (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![FullProduct](https://dpbavq092lwjh.cloudfront.net/visual_styles/FullProduct.png) * `MagnifyingGlassCircle` - MagnifyingGlassCircle (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![MagnifyingGlassCircle](https://dpbavq092lwjh.cloudfront.net/visual_styles/MagnifyingGlassCircle.png) * `ReverseMagnifyingGlassCircle` - ReverseMagnifyingGlassCircle (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![ReverseMagnifyingGlassCircle](https://dpbavq092lwjh.cloudfront.net/visual_styles/ReverseMagnifyingGlassCircle.png) * `TwitterFrame` - TwitterFrame (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![TwitterFrame](https://dpbavq092lwjh.cloudfront.net/visual_styles/TwitterFrame.png) * `DramaticFullProduct` - DramaticFullProduct (Applicable to aspect_ratio 9x16) ![DramaticFullProduct](https://dpbavq092lwjh.cloudfront.net/visual_styles/DramaticFullProduct.png) * `Dramatic` - Dramatic (Applicable to aspect_ratio 9x16) ![Dramatic](https://dpbavq092lwjh.cloudfront.net/visual_styles/Dramatic.png) * `Vanilla` - Vanilla (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![Vanilla](https://dpbavq092lwjh.cloudfront.net/visual_styles/Vanilla.png) * `Vlog` - Vlog (Applicable to aspect_ratio 9x16) ![Vlog](https://dpbavq092lwjh.cloudfront.net/visual_styles/Vlog.png) - 'FullAvatar' | 'GreenScreenEffect' | 'FullAvatarScreenProductOverlay' | 'UpAndDown' | 'SideBySide' | 'FullProduct' | 'MagnifyingGlassCircle' | 'ReverseMagnifyingGlassCircle' | 'TwitterFrame' | 'DramaticFullProduct' | 'Dramatic' | 'Vanilla' | 'Vlog' — * `FullAvatar` - FullAvatar (Applicable to aspect_ratio 9x16, 16x9, 1x1) ![FullAvatar](https://dpbavq092lwjh.cloudfront.net/visual_styles/FullAvatar.png) * `GreenScreenEffect` - GreenScreenEffect (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![GreenScreenEffect](https://dpbavq092lwjh.cloudfront.net/visual_styles/GreenScreenEffect.png) * `FullAvatarScreenProductOverlay` - FullAvatarScreenProductOverlay (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![FullAvatarScreenProductOverlay](https://dpbavq092lwjh.cloudfront.net/visual_styles/FullAvatarScreenProductOverlay.png) * `UpAndDown` - UpAndDown (Applicable to aspect_ratio 1x1, 9x16) ![UpAndDown](https://dpbavq092lwjh.cloudfront.net/visual_styles/UpAndDown.png) * `SideBySide` - SideBySide (Applicable to aspect_ratio 1x1, 16x9) ![SideBySide](https://dpbavq092lwjh.cloudfront.net/visual_styles/SideBySide.png) * `FullProduct` - FullProduct (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![FullProduct](https://dpbavq092lwjh.cloudfront.net/visual_styles/FullProduct.png) * `MagnifyingGlassCircle` - MagnifyingGlassCircle (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![MagnifyingGlassCircle](https://dpbavq092lwjh.cloudfront.net/visual_styles/MagnifyingGlassCircle.png) * `ReverseMagnifyingGlassCircle` - ReverseMagnifyingGlassCircle (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![ReverseMagnifyingGlassCircle](https://dpbavq092lwjh.cloudfront.net/visual_styles/ReverseMagnifyingGlassCircle.png) * `TwitterFrame` - TwitterFrame (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![TwitterFrame](https://dpbavq092lwjh.cloudfront.net/visual_styles/TwitterFrame.png) * `DramaticFullProduct` - DramaticFullProduct (Applicable to aspect_ratio 9x16) ![DramaticFullProduct](https://dpbavq092lwjh.cloudfront.net/visual_styles/DramaticFullProduct.png) * `Dramatic` - Dramatic (Applicable to aspect_ratio 9x16) ![Dramatic](https://dpbavq092lwjh.cloudfront.net/visual_styles/Dramatic.png) * `Vanilla` - Vanilla (Applicable to aspect_ratio 1x1, 16x9, 9x16) ![Vanilla](https://dpbavq092lwjh.cloudfront.net/visual_styles/Vanilla.png) * `Vlog` - Vlog (Applicable to aspect_ratio 9x16) ![Vlog](https://dpbavq092lwjh.cloudfront.net/visual_styles/Vlog.png) - unknown - `cta` CTAInput - `cta_logo` CTALogo - `url` string, uri, required — URL for the logo. - `scale` number, double — Scale of the logo, ranging from 0.0 to 2.0. Set to 0.0 for automatic scaling based on optimal size. - `offset` CTALogoOffset, required - `x` number, double — X offset for the logo. - `y` number, double — Y offset for the logo. - `cta_caption` CTACaption - `caption` string, required — Caption for the CTA. - `caption_setting` CTACaptionSetting - `style` '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' | 'zoom-punch' — * `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 * `zoom-punch` - ZOOM_PUNCH - `offset` CTACaptionOffset - `x` number, double — X offset for the caption. - `y` number, double — Y offset for the caption. - `font_family` 'Montserrat' | 'Jockey One' | 'Lilita One' | 'Mclaren' | 'Corben' | 'Dela Gothic One' | 'Comfortaa' | 'Luckiest Guy' | 'Quantico' | 'Poppins' — * `Montserrat` - Montserrat * `Jockey One` - JockeyOne * `Lilita One` - LilitaOne * `Mclaren` - Mclaren * `Corben` - Corben * `Dela Gothic One` - DelaGothicOne * `Comfortaa` - Comfortaa * `Luckiest Guy` - LuckiestGuy * `Quantico` - Quantico * `Poppins` - Poppins - `font_size` integer — Font size - `font_style` union — Font style * `font-bold` - BOLD * `italic` - ITALIC * `underline` - UNDERLINE - 'font-bold' | 'italic' | 'underline' — * `font-bold` - BOLD * `italic` - ITALIC * `underline` - UNDERLINE - unknown - `background_color` string, nullable — Caption background color, hex color with an alpha channel: #RRGGBBAA. - `text_color` string, nullable — Caption text color, hex color with an alpha channel: #RRGGBBAA. - `highlight_text_color` string, nullable — Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA. - `max_width` integer, nullable — Caption max width in px - `line_height` number, double — Line height for the caption. - `text_shadow` string, nullable — Caption text shadow - `hidden` boolean — Hide caption - `override_visual_style` boolean — If true, these caption settings will override the visual style's default caption settings. Only effective when visual_style is set. - `cta_background_blur` boolean — Blur the background of the CTA. - `transition_effect` Transition - `transition_in` union — Transition effect for entering the video input. Can be null for no transition. * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - 'fade' | 'leftSwipe' | 'rightSwipe' | 'topSwipe' | 'bottomSwipe' — * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - unknown - `transition_out` union — Transition effect for exiting the video input. Can be null for no transition. * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - 'fade' | 'leftSwipe' | 'rightSwipe' | 'topSwipe' | 'bottomSwipe' — * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - unknown - `aspect_ratio` '9x16' | '16x9' | '1x1' — * `9x16` - 9X16 * `16x9` - 16X9 * `1x1` - 1X1 - `background_music` BackgroundMusic - `url` string, uri — URL for the background music. - `volume` number, double — Volume of the background music, ranging from 0.0 to 1.0. - `cta_end` CTAEndInput - `cta_logo` CTALogo - `url` string, uri, required — URL for the logo. - `scale` number, double — Scale of the logo, ranging from 0.0 to 2.0. Set to 0.0 for automatic scaling based on optimal size. - `offset` CTALogoOffset, required - `x` number, double — X offset for the logo. - `y` number, double — Y offset for the logo. - `cta_caption` CTACaption - `caption` string, required — Caption for the CTA. - `caption_setting` CTACaptionSetting - `style` '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' | 'zoom-punch' — * `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 * `zoom-punch` - ZOOM_PUNCH - `offset` CTACaptionOffset - `x` number, double — X offset for the caption. - `y` number, double — Y offset for the caption. - `font_family` 'Montserrat' | 'Jockey One' | 'Lilita One' | 'Mclaren' | 'Corben' | 'Dela Gothic One' | 'Comfortaa' | 'Luckiest Guy' | 'Quantico' | 'Poppins' — * `Montserrat` - Montserrat * `Jockey One` - JockeyOne * `Lilita One` - LilitaOne * `Mclaren` - Mclaren * `Corben` - Corben * `Dela Gothic One` - DelaGothicOne * `Comfortaa` - Comfortaa * `Luckiest Guy` - LuckiestGuy * `Quantico` - Quantico * `Poppins` - Poppins - `font_size` integer — Font size - `font_style` union — Font style * `font-bold` - BOLD * `italic` - ITALIC * `underline` - UNDERLINE - 'font-bold' | 'italic' | 'underline' — * `font-bold` - BOLD * `italic` - ITALIC * `underline` - UNDERLINE - unknown - `background_color` string, nullable — Caption background color, hex color with an alpha channel: #RRGGBBAA. - `text_color` string, nullable — Caption text color, hex color with an alpha channel: #RRGGBBAA. - `highlight_text_color` string, nullable — Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA. - `max_width` integer, nullable — Caption max width in px - `line_height` number, double — Line height for the caption. - `text_shadow` string, nullable — Caption text shadow - `hidden` boolean — Hide caption - `override_visual_style` boolean — If true, these caption settings will override the visual style's default caption settings. Only effective when visual_style is set. - `cta_background_blur` boolean — Blur the background of the CTA. - `transition_effect` Transition - `transition_in` union — Transition effect for entering the video input. Can be null for no transition. * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - 'fade' | 'leftSwipe' | 'rightSwipe' | 'topSwipe' | 'bottomSwipe' — * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - unknown - `transition_out` union — Transition effect for exiting the video input. Can be null for no transition. * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - 'fade' | 'leftSwipe' | 'rightSwipe' | 'topSwipe' | 'bottomSwipe' — * `fade` - fade * `leftSwipe` - leftSwipe * `rightSwipe` - rightSwipe * `topSwipe` - topSwipe * `bottomSwipe` - bottomSwipe - unknown - `cta_duration` integer — Duration of the CTA in seconds. - `cta_background` Background, required - `type` 'image' | 'video', required — * `image` - image * `video` - video - `url` string, uri, required — Background URL. - `fit` 'cover' | 'crop' | 'contain' — * `cover` - deprecated, use 'crop' instead * `crop` - The entire object is cropped to fill the box. The left/right or top/bottom of the object will be cropped. * `contain` - 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. - `effect` union — Effect applied to the background image. Can be null for no effect. * `imageSlideLeft` - imageSlideLeft * `imageZoomIn` - imageZoomIn * `imageZoomOut` - imageZoomOut * `imageWobbling` - imageWobbling * `imageThrob` - imageThrob - 'imageSlideLeft' | 'imageZoomIn' | 'imageZoomOut' | 'imageWobbling' | 'imageThrob' — * `imageSlideLeft` - imageSlideLeft * `imageZoomIn` - imageZoomIn * `imageZoomOut` - imageZoomOut * `imageWobbling` - imageWobbling * `imageThrob` - imageThrob - unknown - `webhook_url` string, uri - `name` string — The name of the lipsync request. - `model_version` 'standard' | 'aurora_v1' | 'aurora_v1_fast' — * `standard` - Standard * `aurora_v1` - Aurora v1 * `aurora_v1_fast` - Aurora v1 Fast ## Response `200` - MultiAvatarLipsyncOutput - `id` string, uuid, required - `name` string, nullable — The name of the lipsync request. - `output` string, nullable, required — Output video - `video_thumbnail` string, uri, required — Generated Video Thumbnail URL - `created_at` string, date-time, required - `updated_at` string, date-time, required - `credits_used` number, required — Credits used in this API call - `duration` integer, required — Duration of the video in seconds - `progress` string, required - `failed_reason` string, nullable, required — The reason for failure, if the lipsync request failed - `media_job` string, uuid, nullable — The media job associated with the lipsync request. - `status` string, required — Status of the lipsync request - `webhook_url` string, uri, nullable — The webhook URL to be called upon completion of the lipsync request - `preview` string, nullable, required — Preview video - `editor_url` string, nullable, required — Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled. - `aspect_ratio` '16x9' | '1x1' | '9x16', required — * `16x9` - Ratio 16 9 * `1x1` - Ratio 1 1 * `9x16` - Ratio 9 16 - `model_version` 'standard' | 'aurora_v1' | 'aurora_v1_fast' — * `standard` - Standard * `aurora_v1` - Aurora v1 * `aurora_v1_fast` - Aurora v1 Fast - `video_inputs` unknown[], required - unknown --- [API](https://skmtc.dev/creatify/apis/creatify-ai-api.md) · [All operations](https://skmtc.dev/creatify/apis/creatify-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/creatify/creatify-ai-api/revisions/7ca3bf8077ba/schema)