Create an AI Avatar task

cURL

curl --request POST \
  --url https://api.creatify.ai/api/lipsyncs/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "text": "<string>",
  "audio": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "green_screen": true,
  "transparent_background": true,
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "no_caption": true,
  "no_music": true,
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>"
}
'

import requests

url = "https://api.creatify.ai/api/lipsyncs/"

payload = {
    "name": "<string>",
    "text": "<string>",
    "audio": "<string>",
    "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "green_screen": True,
    "transparent_background": True,
    "webhook_url": "<string>",
    "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "no_caption": True,
    "no_music": True,
    "caption_offset_x": "<string>",
    "caption_offset_y": "<string>"
}
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({
    name: '<string>',
    text: '<string>',
    audio: '<string>',
    creator: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    green_screen: true,
    transparent_background: true,
    webhook_url: '<string>',
    accent: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    no_caption: true,
    no_music: true,
    caption_offset_x: '<string>',
    caption_offset_y: '<string>'
  })
};

fetch('https://api.creatify.ai/api/lipsyncs/', 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/lipsyncs/",
  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([
    'name' => '<string>',
    'text' => '<string>',
    'audio' => '<string>',
    'creator' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'green_screen' => true,
    'transparent_background' => true,
    'webhook_url' => '<string>',
    'accent' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'no_caption' => true,
    'no_music' => true,
    'caption_offset_x' => '<string>',
    'caption_offset_y' => '<string>'
  ]),
  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/lipsyncs/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"text\": \"<string>\",\n  \"audio\": \"<string>\",\n  \"creator\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"green_screen\": true,\n  \"transparent_background\": true,\n  \"webhook_url\": \"<string>\",\n  \"accent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"no_caption\": true,\n  \"no_music\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\"\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/lipsyncs/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"text\": \"<string>\",\n  \"audio\": \"<string>\",\n  \"creator\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"green_screen\": true,\n  \"transparent_background\": true,\n  \"webhook_url\": \"<string>\",\n  \"accent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"no_caption\": true,\n  \"no_music\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"text\": \"<string>\",\n  \"audio\": \"<string>\",\n  \"creator\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"green_screen\": true,\n  \"transparent_background\": true,\n  \"webhook_url\": \"<string>\",\n  \"accent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"no_caption\": true,\n  \"no_music\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": "<string>",
  "video_thumbnail": "<string>",
  "aspect_ratio": "16x9",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credits_used": 123,
  "duration": 123,
  "progress": "<string>",
  "failed_reason": "<string>",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "is_hidden": true,
  "audio_url": "<string>",
  "preview": "<string>",
  "editor_url": "<string>",
  "preview_audio": "<string>",
  "name": "<string>",
  "text": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "model_version": "standard",
  "green_screen": true,
  "transparent_background": true,
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "no_caption": true,
  "no_music": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>"
}

POST

api

lipsyncs

cURL

curl --request POST \
  --url https://api.creatify.ai/api/lipsyncs/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "text": "<string>",
  "audio": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "green_screen": true,
  "transparent_background": true,
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "no_caption": true,
  "no_music": true,
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>"
}
'

import requests

url = "https://api.creatify.ai/api/lipsyncs/"

payload = {
    "name": "<string>",
    "text": "<string>",
    "audio": "<string>",
    "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "green_screen": True,
    "transparent_background": True,
    "webhook_url": "<string>",
    "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "no_caption": True,
    "no_music": True,
    "caption_offset_x": "<string>",
    "caption_offset_y": "<string>"
}
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({
    name: '<string>',
    text: '<string>',
    audio: '<string>',
    creator: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    green_screen: true,
    transparent_background: true,
    webhook_url: '<string>',
    accent: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    no_caption: true,
    no_music: true,
    caption_offset_x: '<string>',
    caption_offset_y: '<string>'
  })
};

fetch('https://api.creatify.ai/api/lipsyncs/', 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/lipsyncs/",
  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([
    'name' => '<string>',
    'text' => '<string>',
    'audio' => '<string>',
    'creator' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'green_screen' => true,
    'transparent_background' => true,
    'webhook_url' => '<string>',
    'accent' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'no_caption' => true,
    'no_music' => true,
    'caption_offset_x' => '<string>',
    'caption_offset_y' => '<string>'
  ]),
  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/lipsyncs/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"text\": \"<string>\",\n  \"audio\": \"<string>\",\n  \"creator\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"green_screen\": true,\n  \"transparent_background\": true,\n  \"webhook_url\": \"<string>\",\n  \"accent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"no_caption\": true,\n  \"no_music\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\"\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/lipsyncs/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"text\": \"<string>\",\n  \"audio\": \"<string>\",\n  \"creator\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"green_screen\": true,\n  \"transparent_background\": true,\n  \"webhook_url\": \"<string>\",\n  \"accent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"no_caption\": true,\n  \"no_music\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"text\": \"<string>\",\n  \"audio\": \"<string>\",\n  \"creator\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"green_screen\": true,\n  \"transparent_background\": true,\n  \"webhook_url\": \"<string>\",\n  \"accent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"no_caption\": true,\n  \"no_music\": true,\n  \"caption_offset_x\": \"<string>\",\n  \"caption_offset_y\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": "<string>",
  "video_thumbnail": "<string>",
  "aspect_ratio": "16x9",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credits_used": 123,
  "duration": 123,
  "progress": "<string>",
  "failed_reason": "<string>",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "is_hidden": true,
  "audio_url": "<string>",
  "preview": "<string>",
  "editor_url": "<string>",
  "preview_audio": "<string>",
  "name": "<string>",
  "text": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "model_version": "standard",
  "green_screen": true,
  "transparent_background": true,
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "no_caption": true,
  "no_music": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>"
}

About Request Data Structure of Webhook

When the ‘create a lipsync task’ interface is requested, if the ‘webhook_url’ is passed in the parameters, the program will initiate a POST request to this network address when the task succeeds or fails, with the following content:

{
    'id': 'string',
    'status': 'string',
    'failed_reason': 'string',
    'output': 'string',
}

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
output (string): The URL of the video if the job is done

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

aspect_ratio

enum<string>

required

The aspect ratio of the video

16x9 - Ratio 16 9
1x1 - Ratio 1 1
9x16 - Ratio 9 16

Available options:

16x9,

1x1,

9x16

name

string | null

The name of the lipsync request.

Maximum string length: 255

text

string | null

The text to be used for voiceover

Maximum string length: 8000

audio

string<uri> | null

write-only

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> | null

The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.

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

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.

webhook_url

string<uri> | null

The webhook URL to be called upon completion of the lipsync request

Maximum string length: 200

accent

string<uuid> | null

The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.

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

enum<string>

The style of the captions

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>

Caption offset x is horizontaly relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to 0

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

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

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

Response

201 - application/json

string<uuid>

required

read-only

output

string | null

required

read-only

Output video

video_thumbnail

string<uri>

required

read-only

Generated Video Thumbnail URL

aspect_ratio

enum<string>

required

The aspect ratio of the video

16x9 - Ratio 16 9
1x1 - Ratio 1 1
9x16 - Ratio 9 16

Available options:

16x9,

1x1,

9x16

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

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

failed_reason

string | null

required

read-only

The reason for failure, if the lipsync request failed

media_job

string<uuid> | null

required

read-only

The media job associated with the lipsync request.

status

string

required

read-only

Status of the lipsync request

is_hidden

boolean

required

read-only

Is the video hidden in the website projects page

audio_url

string | null

required

read-only

preview

string | null

required

read-only

Preview video

editor_url

string | null

required

read-only

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

preview_audio

string | null

required

read-only

Preview audio

name

string | null

The name of the lipsync request.

Maximum string length: 255

text

string | null

The text to be used for voiceover

Maximum string length: 8000

creator

string<uuid> | null

The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.

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

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.

webhook_url

string<uri> | null

The webhook URL to be called upon completion of the lipsync request

Maximum string length: 200

accent

string<uuid> | null

The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.

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

enum<string>

The style of the captions

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>

Caption offset x is horizontaly relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to 0

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

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

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

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)

Create an AI Avatar task

About Request Data Structure of Webhook

Authorizations

Body

Response