Generate a list of Previews Async

cURL

curl --request POST \
  --url https://api.creatify.ai/api/link_to_videos/preview_list_async/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visual_styles": [],
  "name": "<string>",
  "target_platform": "<string>",
  "target_audience": "<string>",
  "override_avatar": "<string>",
  "override_avatar_by_image": "<string>",
  "override_voice": "<string>",
  "override_script": "<string>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "no_background_music": true,
  "no_caption": true,
  "no_emotion": true,
  "no_cta": true,
  "no_stock_broll": true,
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "caption_setting": {
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_size": 123,
    "background_color": "<string>",
    "text_color": "<string>",
    "highlight_text_color": "<string>",
    "max_width": 123,
    "line_height": 123,
    "text_shadow": "<string>",
    "hidden": false,
    "override_visual_style": false
  },
  "aspect_ratios": []
}
'

import requests

url = "https://api.creatify.ai/api/link_to_videos/preview_list_async/"

payload = {
    "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visual_styles": [],
    "name": "<string>",
    "target_platform": "<string>",
    "target_audience": "<string>",
    "override_avatar": "<string>",
    "override_avatar_by_image": "<string>",
    "override_voice": "<string>",
    "override_script": "<string>",
    "background_music_url": "<string>",
    "background_music_volume": 0.5,
    "voiceover_volume": 0.5,
    "webhook_url": "<string>",
    "no_background_music": True,
    "no_caption": True,
    "no_emotion": True,
    "no_cta": True,
    "no_stock_broll": True,
    "caption_offset_x": "<string>",
    "caption_offset_y": "<string>",
    "caption_setting": {
        "offset": {
            "x": 0,
            "y": 0.4
        },
        "font_size": 123,
        "background_color": "<string>",
        "text_color": "<string>",
        "highlight_text_color": "<string>",
        "max_width": 123,
        "line_height": 123,
        "text_shadow": "<string>",
        "hidden": False,
        "override_visual_style": False
    },
    "aspect_ratios": []
}
headers = {
    "X-API-ID": "<api-key>",
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-ID': '<api-key>',
    'X-API-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    link: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    visual_styles: [],
    name: '<string>',
    target_platform: '<string>',
    target_audience: '<string>',
    override_avatar: '<string>',
    override_avatar_by_image: '<string>',
    override_voice: '<string>',
    override_script: '<string>',
    background_music_url: '<string>',
    background_music_volume: 0.5,
    voiceover_volume: 0.5,
    webhook_url: '<string>',
    no_background_music: true,
    no_caption: true,
    no_emotion: true,
    no_cta: true,
    no_stock_broll: true,
    caption_offset_x: '<string>',
    caption_offset_y: '<string>',
    caption_setting: {
      offset: {x: 0, y: 0.4},
      font_size: 123,
      background_color: '<string>',
      text_color: '<string>',
      highlight_text_color: '<string>',
      max_width: 123,
      line_height: 123,
      text_shadow: '<string>',
      hidden: false,
      override_visual_style: false
    },
    aspect_ratios: []
  })
};

fetch('https://api.creatify.ai/api/link_to_videos/preview_list_async/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.creatify.ai/api/link_to_videos/preview_list_async/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'link' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'visual_styles' => [
        
    ],
    'name' => '<string>',
    'target_platform' => '<string>',
    'target_audience' => '<string>',
    'override_avatar' => '<string>',
    'override_avatar_by_image' => '<string>',
    'override_voice' => '<string>',
    'override_script' => '<string>',
    'background_music_url' => '<string>',
    'background_music_volume' => 0.5,
    'voiceover_volume' => 0.5,
    'webhook_url' => '<string>',
    'no_background_music' => true,
    'no_caption' => true,
    'no_emotion' => true,
    'no_cta' => true,
    'no_stock_broll' => true,
    'caption_offset_x' => '<string>',
    'caption_offset_y' => '<string>',
    'caption_setting' => [
        'offset' => [
                'x' => 0,
                'y' => 0.4
        ],
        'font_size' => 123,
        'background_color' => '<string>',
        'text_color' => '<string>',
        'highlight_text_color' => '<string>',
        'max_width' => 123,
        'line_height' => 123,
        'text_shadow' => '<string>',
        'hidden' => false,
        'override_visual_style' => false
    ],
    'aspect_ratios' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-ID: <api-key>",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.creatify.ai/api/link_to_videos/preview_list_async/"

	payload := strings.NewReader("{\n  \"link\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visual_styles\": [],\n  \"name\": \"<string>\",\n  \"target_platform\": \"<string>\",\n  \"target_audience\": \"<string>\",\n  \"override_avatar\": \"<string>\",\n  \"override_avatar_by_image\": \"<string>\",\n  \"override_voice\": \"<string>\",\n  \"override_script\": \"<string>\",\n  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\",\n  \"no_background_music\": true,\n  \"no_caption\": true,\n  \"no_emotion\": true,\n  \"no_cta\": true,\n  \"no_stock_broll\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\",\n  \"caption_setting\": {\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_size\": 123,\n    \"background_color\": \"<string>\",\n    \"text_color\": \"<string>\",\n    \"highlight_text_color\": \"<string>\",\n    \"max_width\": 123,\n    \"line_height\": 123,\n    \"text_shadow\": \"<string>\",\n    \"hidden\": false,\n    \"override_visual_style\": false\n  },\n  \"aspect_ratios\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-ID", "<api-key>")
	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.creatify.ai/api/link_to_videos/preview_list_async/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"link\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visual_styles\": [],\n  \"name\": \"<string>\",\n  \"target_platform\": \"<string>\",\n  \"target_audience\": \"<string>\",\n  \"override_avatar\": \"<string>\",\n  \"override_avatar_by_image\": \"<string>\",\n  \"override_voice\": \"<string>\",\n  \"override_script\": \"<string>\",\n  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\",\n  \"no_background_music\": true,\n  \"no_caption\": true,\n  \"no_emotion\": true,\n  \"no_cta\": true,\n  \"no_stock_broll\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\",\n  \"caption_setting\": {\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_size\": 123,\n    \"background_color\": \"<string>\",\n    \"text_color\": \"<string>\",\n    \"highlight_text_color\": \"<string>\",\n    \"max_width\": 123,\n    \"line_height\": 123,\n    \"text_shadow\": \"<string>\",\n    \"hidden\": false,\n    \"override_visual_style\": false\n  },\n  \"aspect_ratios\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.creatify.ai/api/link_to_videos/preview_list_async/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"link\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visual_styles\": [],\n  \"name\": \"<string>\",\n  \"target_platform\": \"<string>\",\n  \"target_audience\": \"<string>\",\n  \"override_avatar\": \"<string>\",\n  \"override_avatar_by_image\": \"<string>\",\n  \"override_voice\": \"<string>\",\n  \"override_script\": \"<string>\",\n  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\",\n  \"no_background_music\": true,\n  \"no_caption\": true,\n  \"no_emotion\": true,\n  \"no_cta\": true,\n  \"no_stock_broll\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\",\n  \"caption_setting\": {\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_size\": 123,\n    \"background_color\": \"<string>\",\n    \"text_color\": \"<string>\",\n    \"highlight_text_color\": \"<string>\",\n    \"max_width\": 123,\n    \"line_height\": 123,\n    \"text_shadow\": \"<string>\",\n    \"hidden\": false,\n    \"override_visual_style\": false\n  },\n  \"aspect_ratios\": []\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "failed_reason": "<string>",
  "is_hidden": true,
  "video_output": "<string>",
  "video_thumbnail": "<string>",
  "outputs": [
    {
      "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visual_style": "AvatarBubbleTemplate",
      "video_output": "<string>",
      "video_thumbnail": "<string>",
      "status": "pending",
      "progress": 123,
      "failed_reason": "<string>",
      "aspect_ratio": "9x16",
      "duration": 123
    }
  ],
  "credits_used": 123,
  "duration": 123,
  "progress": "<string>",
  "preview": "<string>",
  "previews": [
    {
      "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visual_style": "AvatarBubbleTemplate",
      "url": "<string>",
      "editor_url": "<string>",
      "aspect_ratio": "9x16",
      "duration": 123
    }
  ],
  "editor_url": "<string>",
  "visual_styles": [
    "AvatarBubbleTemplate"
  ],
  "name": "<string>",
  "target_platform": "<string>",
  "target_audience": "<string>",
  "language": "af",
  "video_length": 15,
  "aspect_ratio": "9x16",
  "script_style": "BenefitsV2",
  "override_avatar": "<string>",
  "override_avatar_by_image": "<string>",
  "override_voice": "<string>",
  "override_script": "<string>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "no_background_music": true,
  "no_caption": true,
  "no_emotion": true,
  "no_cta": true,
  "no_stock_broll": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 123,
    "font_style": "font-bold",
    "background_color": "<string>",
    "text_color": "<string>",
    "highlight_text_color": "<string>",
    "max_width": 123,
    "line_height": 123,
    "text_shadow": "<string>",
    "hidden": false,
    "override_visual_style": false
  },
  "model_version": "standard",
  "aspect_ratios": [
    "9x16"
  ]
}

POST

api

link_to_videos

preview_list_async

cURL

curl --request POST \
  --url https://api.creatify.ai/api/link_to_videos/preview_list_async/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visual_styles": [],
  "name": "<string>",
  "target_platform": "<string>",
  "target_audience": "<string>",
  "override_avatar": "<string>",
  "override_avatar_by_image": "<string>",
  "override_voice": "<string>",
  "override_script": "<string>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "no_background_music": true,
  "no_caption": true,
  "no_emotion": true,
  "no_cta": true,
  "no_stock_broll": true,
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "caption_setting": {
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_size": 123,
    "background_color": "<string>",
    "text_color": "<string>",
    "highlight_text_color": "<string>",
    "max_width": 123,
    "line_height": 123,
    "text_shadow": "<string>",
    "hidden": false,
    "override_visual_style": false
  },
  "aspect_ratios": []
}
'

import requests

url = "https://api.creatify.ai/api/link_to_videos/preview_list_async/"

payload = {
    "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visual_styles": [],
    "name": "<string>",
    "target_platform": "<string>",
    "target_audience": "<string>",
    "override_avatar": "<string>",
    "override_avatar_by_image": "<string>",
    "override_voice": "<string>",
    "override_script": "<string>",
    "background_music_url": "<string>",
    "background_music_volume": 0.5,
    "voiceover_volume": 0.5,
    "webhook_url": "<string>",
    "no_background_music": True,
    "no_caption": True,
    "no_emotion": True,
    "no_cta": True,
    "no_stock_broll": True,
    "caption_offset_x": "<string>",
    "caption_offset_y": "<string>",
    "caption_setting": {
        "offset": {
            "x": 0,
            "y": 0.4
        },
        "font_size": 123,
        "background_color": "<string>",
        "text_color": "<string>",
        "highlight_text_color": "<string>",
        "max_width": 123,
        "line_height": 123,
        "text_shadow": "<string>",
        "hidden": False,
        "override_visual_style": False
    },
    "aspect_ratios": []
}
headers = {
    "X-API-ID": "<api-key>",
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-ID': '<api-key>',
    'X-API-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    link: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    visual_styles: [],
    name: '<string>',
    target_platform: '<string>',
    target_audience: '<string>',
    override_avatar: '<string>',
    override_avatar_by_image: '<string>',
    override_voice: '<string>',
    override_script: '<string>',
    background_music_url: '<string>',
    background_music_volume: 0.5,
    voiceover_volume: 0.5,
    webhook_url: '<string>',
    no_background_music: true,
    no_caption: true,
    no_emotion: true,
    no_cta: true,
    no_stock_broll: true,
    caption_offset_x: '<string>',
    caption_offset_y: '<string>',
    caption_setting: {
      offset: {x: 0, y: 0.4},
      font_size: 123,
      background_color: '<string>',
      text_color: '<string>',
      highlight_text_color: '<string>',
      max_width: 123,
      line_height: 123,
      text_shadow: '<string>',
      hidden: false,
      override_visual_style: false
    },
    aspect_ratios: []
  })
};

fetch('https://api.creatify.ai/api/link_to_videos/preview_list_async/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.creatify.ai/api/link_to_videos/preview_list_async/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'link' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'visual_styles' => [
        
    ],
    'name' => '<string>',
    'target_platform' => '<string>',
    'target_audience' => '<string>',
    'override_avatar' => '<string>',
    'override_avatar_by_image' => '<string>',
    'override_voice' => '<string>',
    'override_script' => '<string>',
    'background_music_url' => '<string>',
    'background_music_volume' => 0.5,
    'voiceover_volume' => 0.5,
    'webhook_url' => '<string>',
    'no_background_music' => true,
    'no_caption' => true,
    'no_emotion' => true,
    'no_cta' => true,
    'no_stock_broll' => true,
    'caption_offset_x' => '<string>',
    'caption_offset_y' => '<string>',
    'caption_setting' => [
        'offset' => [
                'x' => 0,
                'y' => 0.4
        ],
        'font_size' => 123,
        'background_color' => '<string>',
        'text_color' => '<string>',
        'highlight_text_color' => '<string>',
        'max_width' => 123,
        'line_height' => 123,
        'text_shadow' => '<string>',
        'hidden' => false,
        'override_visual_style' => false
    ],
    'aspect_ratios' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-ID: <api-key>",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.creatify.ai/api/link_to_videos/preview_list_async/"

	payload := strings.NewReader("{\n  \"link\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visual_styles\": [],\n  \"name\": \"<string>\",\n  \"target_platform\": \"<string>\",\n  \"target_audience\": \"<string>\",\n  \"override_avatar\": \"<string>\",\n  \"override_avatar_by_image\": \"<string>\",\n  \"override_voice\": \"<string>\",\n  \"override_script\": \"<string>\",\n  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\",\n  \"no_background_music\": true,\n  \"no_caption\": true,\n  \"no_emotion\": true,\n  \"no_cta\": true,\n  \"no_stock_broll\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\",\n  \"caption_setting\": {\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_size\": 123,\n    \"background_color\": \"<string>\",\n    \"text_color\": \"<string>\",\n    \"highlight_text_color\": \"<string>\",\n    \"max_width\": 123,\n    \"line_height\": 123,\n    \"text_shadow\": \"<string>\",\n    \"hidden\": false,\n    \"override_visual_style\": false\n  },\n  \"aspect_ratios\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-ID", "<api-key>")
	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.creatify.ai/api/link_to_videos/preview_list_async/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"link\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visual_styles\": [],\n  \"name\": \"<string>\",\n  \"target_platform\": \"<string>\",\n  \"target_audience\": \"<string>\",\n  \"override_avatar\": \"<string>\",\n  \"override_avatar_by_image\": \"<string>\",\n  \"override_voice\": \"<string>\",\n  \"override_script\": \"<string>\",\n  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\",\n  \"no_background_music\": true,\n  \"no_caption\": true,\n  \"no_emotion\": true,\n  \"no_cta\": true,\n  \"no_stock_broll\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\",\n  \"caption_setting\": {\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_size\": 123,\n    \"background_color\": \"<string>\",\n    \"text_color\": \"<string>\",\n    \"highlight_text_color\": \"<string>\",\n    \"max_width\": 123,\n    \"line_height\": 123,\n    \"text_shadow\": \"<string>\",\n    \"hidden\": false,\n    \"override_visual_style\": false\n  },\n  \"aspect_ratios\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.creatify.ai/api/link_to_videos/preview_list_async/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"link\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"visual_styles\": [],\n  \"name\": \"<string>\",\n  \"target_platform\": \"<string>\",\n  \"target_audience\": \"<string>\",\n  \"override_avatar\": \"<string>\",\n  \"override_avatar_by_image\": \"<string>\",\n  \"override_voice\": \"<string>\",\n  \"override_script\": \"<string>\",\n  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\",\n  \"no_background_music\": true,\n  \"no_caption\": true,\n  \"no_emotion\": true,\n  \"no_cta\": true,\n  \"no_stock_broll\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\",\n  \"caption_setting\": {\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_size\": 123,\n    \"background_color\": \"<string>\",\n    \"text_color\": \"<string>\",\n    \"highlight_text_color\": \"<string>\",\n    \"max_width\": 123,\n    \"line_height\": 123,\n    \"text_shadow\": \"<string>\",\n    \"hidden\": false,\n    \"override_visual_style\": false\n  },\n  \"aspect_ratios\": []\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "failed_reason": "<string>",
  "is_hidden": true,
  "video_output": "<string>",
  "video_thumbnail": "<string>",
  "outputs": [
    {
      "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visual_style": "AvatarBubbleTemplate",
      "video_output": "<string>",
      "video_thumbnail": "<string>",
      "status": "pending",
      "progress": 123,
      "failed_reason": "<string>",
      "aspect_ratio": "9x16",
      "duration": 123
    }
  ],
  "credits_used": 123,
  "duration": 123,
  "progress": "<string>",
  "preview": "<string>",
  "previews": [
    {
      "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visual_style": "AvatarBubbleTemplate",
      "url": "<string>",
      "editor_url": "<string>",
      "aspect_ratio": "9x16",
      "duration": 123
    }
  ],
  "editor_url": "<string>",
  "visual_styles": [
    "AvatarBubbleTemplate"
  ],
  "name": "<string>",
  "target_platform": "<string>",
  "target_audience": "<string>",
  "language": "af",
  "video_length": 15,
  "aspect_ratio": "9x16",
  "script_style": "BenefitsV2",
  "override_avatar": "<string>",
  "override_avatar_by_image": "<string>",
  "override_voice": "<string>",
  "override_script": "<string>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "no_background_music": true,
  "no_caption": true,
  "no_emotion": true,
  "no_cta": true,
  "no_stock_broll": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 123,
    "font_style": "font-bold",
    "background_color": "<string>",
    "text_color": "<string>",
    "highlight_text_color": "<string>",
    "max_width": 123,
    "line_height": 123,
    "text_shadow": "<string>",
    "hidden": false,
    "override_visual_style": false
  },
  "model_version": "standard",
  "aspect_ratios": [
    "9x16"
  ]
}

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 array length: 1

AvatarBubbleTemplate: Avatar Bubble (Applicable to aspect_ratio 9x16, 16x9, 1x1)
DramaticTemplate: Dramatic (Applicable to aspect_ratio 9x16)
DynamicGreenScreenEffect: Dynamic Green Screen Effect (Applicable to aspect_ratio 9x16, 16x9, 1x1)
DynamicProductTemplate: Product (Applicable to aspect_ratio 9x16, 16x9, 1x1)
DynamicResponseBubbleTemplate: Response Bubble (Applicable to aspect_ratio 9x16)
EnhancedVanillaTemplate: Dynamic Vanilla (Applicable to aspect_ratio 9x16, 16x9, 1x1)
FeatureHighlightTemplate: Feature Highlight (Applicable to aspect_ratio 9x16, 1x1, 16x9)
FullScreenTemplate: Full Screen (Applicable to aspect_ratio 9x16, 16x9, 1x1)
FullScreenV2Template: Full Screen V2 (Applicable to aspect_ratio 9x16, 16x9, 1x1)
GreenScreenEffectTemplate: Green Screen Effect (Applicable to aspect_ratio 9x16, 16x9, 1x1)
MotionCardsTemplate: Motion Cards (Applicable to aspect_ratio 9x16, 16x9, 1x1)
OverCardsTemplate: Over Cards (Applicable to aspect_ratio 9x16, 16x9, 1x1)
QuickFrameTemplate: Quick Frame (Applicable to aspect_ratio 16x9)
QuickTransitionTemplate: Quick Transition (Applicable to aspect_ratio 9x16, 16x9, 1x1)
ScribbleTemplate: Scribble (Applicable to aspect_ratio 9x16, 16x9, 1x1)
SideBySideTemplate: Side by Side (Applicable to aspect_ratio 9x16, 16x9, 1x1)
SimpleAvatarOverlayTemplate: Product Presenter (Applicable to aspect_ratio 9x16, 16x9, 1x1)
TopBottomTemplate: Top & Bottom (Applicable to aspect_ratio 9x16, 1x1)
TwitterFrameTemplate: Twitter Frame (Applicable to aspect_ratio 9x16, 16x9, 1x1)
VanillaTemplate: Vanilla (Applicable to aspect_ratio 9x16, 16x9, 1x1)
VlogTemplate: Vlog (Applicable to aspect_ratio 9x16)
LegoVisualEmotional: Emotional (Applicable to aspect_ratio 9x16, 16x9, 1x1)
LegoVisualCutePets: Cute Pets (Applicable to aspect_ratio 9x16, 16x9, 1x1)
LegoVisualAvatarFocusIntro: Avatar Focus Intro (Applicable to aspect_ratio 9x16, 16x9, 1x1)
LegoScriptNegativeHook: Don’t Use This If You Want... (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptNumberOneHook: The #1 Hack You Need (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptEverWonderHook: Ever Wonder Why? (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptSecretHook: Wish I Could Keep This Secret (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptWhatHappensHook: What Happens If You Try This? (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptAnyoneElseHook: That One Thing We All Have (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptAmazedHook: Still Amazed by This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScript2025Hook: Hack 2025 Like This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptHateMeHook: They’ll Hate Me for This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptResponseBubbleTextOverlay: Response bubble (Applicable to aspect_ratio 9x16, 1x1)
LegoScriptHeyAlgorithmHook: Hey Algorithm (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptCannotBelieveHook: Cannot Believe This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptFinallyConfidentHook: Finally Confident (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptPremiumFeelingHook: Premium Feeling (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptFirstTimeFullHook: First Time Full (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptLongLineReasonHook: Long Line Reason (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptMissingOutAlertHook: Missing Out Alert (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptBetterTodayVersionHook: Better Today Version (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptBigHappeningHook: Big Happening (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptPriceDropRegretHook: Price Drop Regret (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptGroupBuyFrustrationHook: Group Buy Frustration (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptStopAffordExcuseHook: Stop Afford Excuse (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptLifeTooShortDiscountHook: Life Too Short Discount (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptHugePriceDropRushHook: Huge Price Drop Rush (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptPriceCouldGoLowerHook: Price Could Go Lower (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptStillFullPriceHook: Still Full Price (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptSecretDiscountShareHook: Secret Discount Share (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptVoucherSavingsAlertHook: Voucher Savings Alert (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptCouponDiscoveryRegretHook: Coupon Discovery Regret (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptBestDealEverHook: Best Deal Ever (Applicable to aspect_ratio 9x16, 1x1, 16x9)

Available options:

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

name

string | null

Name of the video. Default is null.

Maximum string length: 255

target_platform

string

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

Maximum string 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'.

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

Available options:

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

video_length

enum<integer>

Length of the video in seconds. Default is 15.

15 - 15
30 - 30
45 - 45
60 - 60

Available options:

15,

30,

45,

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 string length: 255

override_avatar_by_image

string<uri> | null

Override avatar by providing an avatar image URL. Default is null.

Maximum string length: 1000

override_voice

string | null

Override voice for the video. Default is null.

Maximum string 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 string length: 255

background_music_volume

number<double> | 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<double> | 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 string 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
zoom-punch - ZOOM_PUNCH

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,

zoom-punch

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.

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$

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.

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$

caption_setting

object | null

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', 'aurora_v1_fast', 'aurora_v2' or 'boreal'. Default is 'standard'. Standard model costs 5 credits per 30 seconds video, Aurora_v1 model costs 1 credit per second, and Aurora_v1_fast renders faster with lower quality for 0.5 credits per second. Aurora_v2 costs 0.7 credits per second. Boreal model costs 10 credits per 30 seconds video.

standard - Standard
aurora_v1 - Aurora v1
aurora_v1_fast - Aurora v1 Fast
boreal - Boreal
aurora_v2 - Aurora v2

Available options:

standard,

aurora_v1,

aurora_v1_fast,

boreal,

aurora_v2

aspect_ratios

enum<string>[] | null

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

Available options:

9x16,

16x9,

1x1

Response

200 - application/json

string<uuid>

required

read-only

link

string<uuid>

required

Link associated with the video.

media_job

string<uuid> | null

required

read-only

Media job associated with the video. Default is null.

status

string

required

read-only

failed_reason

string | null

required

read-only

Reason for failure. Default is null.

is_hidden

boolean

required

read-only

video_output

string<uri>

required

read-only

Generated Video URL

video_thumbnail

string<uri>

required

read-only

Generated Video Thumbnail URL

outputs

object[]

required

read-only

List of outputs

Show child attributes

credits_used

number

required

read-only

Credits used in this API call

duration

integer

required

read-only

Duration of the video in seconds

progress

string

required

read-only

preview

string<uri>

required

read-only

Preview URL

previews

object[]

required

read-only

List of previews

Show child attributes

editor_url

string<uri>

required

read-only

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 array length: 1

AvatarBubbleTemplate: Avatar Bubble (Applicable to aspect_ratio 9x16, 16x9, 1x1)
DramaticTemplate: Dramatic (Applicable to aspect_ratio 9x16)
DynamicGreenScreenEffect: Dynamic Green Screen Effect (Applicable to aspect_ratio 9x16, 16x9, 1x1)
DynamicProductTemplate: Product (Applicable to aspect_ratio 9x16, 16x9, 1x1)
DynamicResponseBubbleTemplate: Response Bubble (Applicable to aspect_ratio 9x16)
EnhancedVanillaTemplate: Dynamic Vanilla (Applicable to aspect_ratio 9x16, 16x9, 1x1)
FeatureHighlightTemplate: Feature Highlight (Applicable to aspect_ratio 9x16, 1x1, 16x9)
FullScreenTemplate: Full Screen (Applicable to aspect_ratio 9x16, 16x9, 1x1)
FullScreenV2Template: Full Screen V2 (Applicable to aspect_ratio 9x16, 16x9, 1x1)
GreenScreenEffectTemplate: Green Screen Effect (Applicable to aspect_ratio 9x16, 16x9, 1x1)
MotionCardsTemplate: Motion Cards (Applicable to aspect_ratio 9x16, 16x9, 1x1)
OverCardsTemplate: Over Cards (Applicable to aspect_ratio 9x16, 16x9, 1x1)
QuickFrameTemplate: Quick Frame (Applicable to aspect_ratio 16x9)
QuickTransitionTemplate: Quick Transition (Applicable to aspect_ratio 9x16, 16x9, 1x1)
ScribbleTemplate: Scribble (Applicable to aspect_ratio 9x16, 16x9, 1x1)
SideBySideTemplate: Side by Side (Applicable to aspect_ratio 9x16, 16x9, 1x1)
SimpleAvatarOverlayTemplate: Product Presenter (Applicable to aspect_ratio 9x16, 16x9, 1x1)
TopBottomTemplate: Top & Bottom (Applicable to aspect_ratio 9x16, 1x1)
TwitterFrameTemplate: Twitter Frame (Applicable to aspect_ratio 9x16, 16x9, 1x1)
VanillaTemplate: Vanilla (Applicable to aspect_ratio 9x16, 16x9, 1x1)
VlogTemplate: Vlog (Applicable to aspect_ratio 9x16)
LegoVisualEmotional: Emotional (Applicable to aspect_ratio 9x16, 16x9, 1x1)
LegoVisualCutePets: Cute Pets (Applicable to aspect_ratio 9x16, 16x9, 1x1)
LegoVisualAvatarFocusIntro: Avatar Focus Intro (Applicable to aspect_ratio 9x16, 16x9, 1x1)
LegoScriptNegativeHook: Don’t Use This If You Want... (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptNumberOneHook: The #1 Hack You Need (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptEverWonderHook: Ever Wonder Why? (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptSecretHook: Wish I Could Keep This Secret (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptWhatHappensHook: What Happens If You Try This? (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptAnyoneElseHook: That One Thing We All Have (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptAmazedHook: Still Amazed by This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScript2025Hook: Hack 2025 Like This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptHateMeHook: They’ll Hate Me for This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptResponseBubbleTextOverlay: Response bubble (Applicable to aspect_ratio 9x16, 1x1)
LegoScriptHeyAlgorithmHook: Hey Algorithm (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptCannotBelieveHook: Cannot Believe This (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptFinallyConfidentHook: Finally Confident (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptPremiumFeelingHook: Premium Feeling (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptFirstTimeFullHook: First Time Full (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptLongLineReasonHook: Long Line Reason (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptMissingOutAlertHook: Missing Out Alert (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptBetterTodayVersionHook: Better Today Version (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptBigHappeningHook: Big Happening (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptPriceDropRegretHook: Price Drop Regret (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptGroupBuyFrustrationHook: Group Buy Frustration (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptStopAffordExcuseHook: Stop Afford Excuse (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptLifeTooShortDiscountHook: Life Too Short Discount (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptHugePriceDropRushHook: Huge Price Drop Rush (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptPriceCouldGoLowerHook: Price Could Go Lower (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptStillFullPriceHook: Still Full Price (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptSecretDiscountShareHook: Secret Discount Share (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptVoucherSavingsAlertHook: Voucher Savings Alert (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptCouponDiscoveryRegretHook: Coupon Discovery Regret (Applicable to aspect_ratio 9x16, 1x1, 16x9)
LegoScriptBestDealEverHook: Best Deal Ever (Applicable to aspect_ratio 9x16, 1x1, 16x9)

Available options:

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

name

string | null

Name of the video. Default is null.

Maximum string length: 255

target_platform

string

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

Maximum string 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'.

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

Available options:

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

video_length

enum<integer>

Length of the video in seconds. Default is 15.

15 - 15
30 - 30
45 - 45
60 - 60

Available options:

15,

30,

45,

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 string length: 255

override_avatar_by_image

string<uri> | null

Override avatar by providing an avatar image URL. Default is null.

Maximum string length: 1000

override_voice

string | null

Override voice for the video. Default is null.

Maximum string 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 string length: 255

background_music_volume

number<double> | 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<double> | 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 string 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
zoom-punch - ZOOM_PUNCH

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,

zoom-punch

caption_offset_x

string<decimal> | null

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$

caption_offset_y

string<decimal> | null

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$

caption_setting

object | null

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

Show child attributes

model_version

enum<string>

standard - Standard
aurora_v1 - Aurora v1
aurora_v1_fast - Aurora v1 Fast
boreal - Boreal
aurora_v2 - Aurora v2

Available options:

standard,

aurora_v1,

aurora_v1_fast,

boreal,

aurora_v2

aspect_ratios

enum<string>[] | null

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

Available options:

9x16,

16x9,

1x1

Get Started

URL to Video

Aurora

Boreal

Stock AI Avatar

Custom Avatar

Custom Template

Asset Generator

Ad Clone

Text to Speech

IAB Images

HTML Interactive Ad

Link Parser

AI Ad Script

Stock AI Voice

Stock AI Music

Workspace

AI Shorts (Deprecated)

AI Editing (Deprecated)

Product Video (Deprecated)

Generate a list of Previews Async

About previews Field in the Response

About Request Data Structure of Webhook

About override_avatar parameter

About override_voice parameter

Authorizations

Body

Response

​About previews Field in the Response

​About Request Data Structure of Webhook

​About override_avatar parameter

​About override_voice parameter

Authorizations

Body

Response

About previews Field in the Response

About Request Data Structure of Webhook

About override_avatar parameter

About override_voice parameter