Generate preview of AI Editing

POST

api

ai_editing

preview

curl --request POST \
  --url https://api.creatify.ai/api/ai_editing/preview/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "editing_style": "film",
  "video_url": "<string>",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 70,
    "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
  },
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>"
}'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "media_job": "<string>",
  "status": "pending",
  "video_output": "<string>",
  "preview": "<string>",
  "credits_used": 123,
  "is_hidden": true,
  "progress": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "permission_type": "private",
  "name": "<string>",
  "script": "<string>",
  "aspect_ratio": "9x16",
  "is_talking_video": true,
  "is_one_person_in_video": true,
  "editing_style": "film",
  "duration": 123,
  "audio_url": "<string>",
  "video_url": "<string>",
  "size": 123,
  "created_from_api": true,
  "caption_setting": "<any>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Queue a preview generation task

Generate a preview of AI Editing video.

import requests

url = "https://api.creatify.ai/api/ai_editing/preview/"

payload = {
    "video_url": "https://d35ghwdno3nak3.cloudfront.net/media_file/2/20240805/038a9606-7b03-4fdd-a44d-122195a97afb_jun-16x9.mp4",
    "editing_style": "film"
}
headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Check preview status

Now our AI model is generating preview of AI Editing video. It will return a id of the AI Editing video. Then you can check the preview status of your video by sending a GET request to Get AI Editing video by id endpoint.

import requests

url = "https://api.creatify.ai/api/ai_editing/{id}/"

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Once the preview of AI Editing video is generated, there will be data in preview field. Then you can render the video by sending a POST request to Render a AI Editing video endpoint.

Render the video

import requests

url = "https://api.creatify.ai/api/ai_editing/{id}/render/"

payload = {}

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Check render status

import requests

url = "https://api.creatify.ai/api/ai_editing/{id}/"

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

You will find the status to be done when finished. Meanwhile you can find the video output in video_output field.

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

editing_style

enum<string>

required

film - Film
geometric_gradient - Geometric Gradient
glitch - Glitch
glitter_gradient - Glitter Gradient
paper - Paper

Available options:

film,

geometric_gradient,

glitch,

glitter_gradient,

paper

video_url

string

required

caption_setting

object

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

caption_setting.style

enum<string>

default:normal-black

Caption style

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

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

caption_setting.offset

object

Caption offset

caption_setting.font_family

enum<string>

default:Montserrat

Font family

Montserrat - Montserrat
Jockey One - JockeyOne
Lilita One - LilitaOne
Mclaren - Mclaren
Corben - Corben
Dela Gothic One - DelaGothicOne
Comfortaa - Comfortaa
Luckiest Guy - LuckiestGuy
Quantico - Quantico
Poppins - Poppins

Available options:

Montserrat,

Jockey One,

Lilita One,

Mclaren,

Corben,

Dela Gothic One,

Comfortaa,

Luckiest Guy,

Quantico,

Poppins

caption_setting.font_size

integer

default:70

Font size

caption_setting.font_style

Font style

font-bold - BOLD
italic - ITALIC
underline - UNDERLINE

Available options:

font-bold,

italic,

underline

caption_setting.background_color

string | null

Caption background color, hex color with an alpha channel: #RRGGBBAA.

caption_setting.text_color

string | null

Caption text color, hex color with an alpha channel: #RRGGBBAA.

caption_setting.highlight_text_color

string | null

Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA.

caption_setting.max_width

integer | null

Caption max width in px

caption_setting.line_height

number | null

Caption line height

caption_setting.text_shadow

string | null

Caption text shadow

caption_setting.hidden

boolean

default:false

Hide caption

background_music_url

string | null

Background music URL for the video. Default is null, video will use random music.

Maximum length: 255

background_music_volume

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

Webhook URL for status updates. Default is null.

Maximum length: 200

Response

200 - application/json

string

required

media_job

string | null

required

status

enum<string>

required

pending - Pending
in_queue - In Queue
running - Running
failed - Failed
done - Done
rejected - Rejected

Available options:

pending,

in_queue,

running,

failed,

done,

rejected

video_output

string | null

required

preview

string | null

required

credits_used

integer

required

Credits used in this api call

is_hidden

boolean

required

progress

number

required

created_at

string

required

updated_at

string

required

permission_type

enum<string>

required

private - Private
workspace - Workspace
public - Public

Available options:

private,

workspace,

public

user

integer | null

required

workspace

string | null

required

name

string

Maximum length: 255

script

string | null

Text to be converted to video

aspect_ratio

Aspect ratio of the video

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

Available options:

9x16,

16x9,

1x1

is_talking_video

boolean

Whether the video is talking video or not

is_one_person_in_video

boolean

Whether the video is one person video or not

editing_style

Style to be used for the video

film - Film
geometric_gradient - Geometric Gradient
glitch - Glitch
glitter_gradient - Glitter Gradient
paper - Paper

Available options:

film,

geometric_gradient,

glitch,

glitter_gradient,

paper

duration

number

Duration of the video

audio_url

string | null

Audio to be used for the video

Maximum length: 255

video_url

string | null

Video to be used for the video

Maximum length: 255

size

number

Size of the video

created_from_api

boolean

Flow is created from api or not

caption_setting

any | null

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

background_music_url

string | null

Background music URL for the video. Default is null, video will use random music.

Maximum length: 255

background_music_volume

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

Webhook URL for status updates. Default is null.

Maximum length: 200

Create a AI Editing task Render a AI Editing video

curl --request POST \
  --url https://api.creatify.ai/api/ai_editing/preview/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "editing_style": "film",
  "video_url": "<string>",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 70,
    "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
  },
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>"
}'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "media_job": "<string>",
  "status": "pending",
  "video_output": "<string>",
  "preview": "<string>",
  "credits_used": 123,
  "is_hidden": true,
  "progress": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "permission_type": "private",
  "name": "<string>",
  "script": "<string>",
  "aspect_ratio": "9x16",
  "is_talking_video": true,
  "is_one_person_in_video": true,
  "editing_style": "film",
  "duration": 123,
  "audio_url": "<string>",
  "video_url": "<string>",
  "size": 123,
  "created_from_api": true,
  "caption_setting": "<any>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

API Documentation

Link to videos

Links

Lipsyncs

Lipsyncs v2

AI Scripts

Text to Speech

AI Shorts

AI Editing

Custom Templates

Avatar

DYOA

Voices

Musics

Workspace

Generate preview of AI Editing

Queue a preview generation task

Check preview status

Render the video

Check render status

Authorizations

Body

Response

API Documentation

Link to videos

Links

Lipsyncs

Lipsyncs v2

AI Scripts

Text to Speech

AI Shorts

AI Editing

Custom Templates

Avatar

DYOA

Voices

Musics

Workspace

​Queue a preview generation task

​Check preview status

​Render the video

​Check render status

Authorizations

Body

Response

Queue a preview generation task

Check preview status

Render the video

Check render status