--- title: "POST /api/lipsyncs/preview/" method: POST path: "/api/lipsyncs/preview/" tags: ["lipsyncs"] --- # POST /api/lipsyncs/preview/ `POST /api/lipsyncs/preview/` Mixin to provide a reusable `list` method for filtering and paginating queryset results. ## Request body - Lipsync - `id` string, uuid, required - `name` string, nullable — The name of the lipsync request. - `text` string, nullable — The text to be used for voiceover - `audio` string, uri, nullable — 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, uuid, nullable — The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint. - `model_version` 'standard' | 'aurora_v1' | 'aurora_v1_fast' — * `standard` - Standard * `aurora_v1` - Aurora v1 * `aurora_v1_fast` - Aurora v1 Fast - `output` string, nullable, required — Output video - `video_thumbnail` string, uri, required — Generated Video Thumbnail URL - `aspect_ratio` '16x9' | '1x1' | '9x16', required — * `16x9` - Ratio 16 9 * `1x1` - Ratio 1 1 * `9x16` - Ratio 9 16 - `green_screen` boolean — When true, the output video will be in .mp4 format with black background and subtitles will not be rendered on the video. Default is false. - `transparent_background` boolean — When true, the output video will be in .webm format with alpha channel (transparency support). Default is false. - `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, 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, nullable, required - `webhook_url` string, uri, nullable — The webhook URL to be called upon completion of the lipsync request - `accent` string, uuid, nullable — The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint. - `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. - `preview_audio` string, nullable, required — Preview audio - `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` '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 - `caption_offset_x` string, decimal — 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, decimal — 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 ## Response `200` - Lipsync - `id` string, uuid, required - `name` string, nullable — The name of the lipsync request. - `text` string, nullable — The text to be used for voiceover - `audio` string, uri, nullable — 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, uuid, nullable — The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint. - `model_version` 'standard' | 'aurora_v1' | 'aurora_v1_fast' — * `standard` - Standard * `aurora_v1` - Aurora v1 * `aurora_v1_fast` - Aurora v1 Fast - `output` string, nullable, required — Output video - `video_thumbnail` string, uri, required — Generated Video Thumbnail URL - `aspect_ratio` '16x9' | '1x1' | '9x16', required — * `16x9` - Ratio 16 9 * `1x1` - Ratio 1 1 * `9x16` - Ratio 9 16 - `green_screen` boolean — When true, the output video will be in .mp4 format with black background and subtitles will not be rendered on the video. Default is false. - `transparent_background` boolean — When true, the output video will be in .webm format with alpha channel (transparency support). Default is false. - `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, 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, nullable, required - `webhook_url` string, uri, nullable — The webhook URL to be called upon completion of the lipsync request - `accent` string, uuid, nullable — The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint. - `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. - `preview_audio` string, nullable, required — Preview audio - `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` '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 - `caption_offset_x` string, decimal — 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, decimal — 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 --- [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)