Generate preview of AI Editing

cURL

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 '
{
  "video_url": "<string>",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 70,
    "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
  },
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>"
}
'

import requests

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

payload = {
    "video_url": "<string>",
    "caption_setting": {
        "style": "normal-black",
        "offset": {
            "x": 0,
            "y": 0.4
        },
        "font_family": "Montserrat",
        "font_size": 70,
        "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
    },
    "background_music_url": "<string>",
    "background_music_volume": 0.5,
    "voiceover_volume": 0.5,
    "webhook_url": "<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({
    video_url: '<string>',
    caption_setting: {
      style: 'normal-black',
      offset: {x: 0, y: 0.4},
      font_family: 'Montserrat',
      font_size: 70,
      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
    },
    background_music_url: '<string>',
    background_music_volume: 0.5,
    voiceover_volume: 0.5,
    webhook_url: '<string>'
  })
};

fetch('https://api.creatify.ai/api/ai_editing/preview/', 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/ai_editing/preview/",
  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([
    'video_url' => '<string>',
    'caption_setting' => [
        'style' => 'normal-black',
        'offset' => [
                'x' => 0,
                'y' => 0.4
        ],
        'font_family' => 'Montserrat',
        'font_size' => 70,
        '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
    ],
    'background_music_url' => '<string>',
    'background_music_volume' => 0.5,
    'voiceover_volume' => 0.5,
    'webhook_url' => '<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/ai_editing/preview/"

	payload := strings.NewReader("{\n  \"video_url\": \"<string>\",\n  \"caption_setting\": {\n    \"style\": \"normal-black\",\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_family\": \"Montserrat\",\n    \"font_size\": 70,\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  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<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/ai_editing/preview/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"<string>\",\n  \"caption_setting\": {\n    \"style\": \"normal-black\",\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_family\": \"Montserrat\",\n    \"font_size\": 70,\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  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"video_url\": \"<string>\",\n  \"caption_setting\": {\n    \"style\": \"normal-black\",\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_family\": \"Montserrat\",\n    \"font_size\": 70,\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  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failed_reason": "<string>",
  "video_output": "<string>",
  "preview": "<string>",
  "editor_url": "<string>",
  "is_hidden": true,
  "progress": 123,
  "credits_used": 123,
  "duration": 123,
  "media_job": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "script": "<string>",
  "is_talking_video": true,
  "is_one_person_in_video": true,
  "audio_url": "<string>",
  "video_url": "<string>",
  "size": 123,
  "created_from_api": true,
  "caption_setting": "<unknown>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

POST

api

ai_editing

preview

cURL

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 '
{
  "video_url": "<string>",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 70,
    "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
  },
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>"
}
'

import requests

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

payload = {
    "video_url": "<string>",
    "caption_setting": {
        "style": "normal-black",
        "offset": {
            "x": 0,
            "y": 0.4
        },
        "font_family": "Montserrat",
        "font_size": 70,
        "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
    },
    "background_music_url": "<string>",
    "background_music_volume": 0.5,
    "voiceover_volume": 0.5,
    "webhook_url": "<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({
    video_url: '<string>',
    caption_setting: {
      style: 'normal-black',
      offset: {x: 0, y: 0.4},
      font_family: 'Montserrat',
      font_size: 70,
      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
    },
    background_music_url: '<string>',
    background_music_volume: 0.5,
    voiceover_volume: 0.5,
    webhook_url: '<string>'
  })
};

fetch('https://api.creatify.ai/api/ai_editing/preview/', 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/ai_editing/preview/",
  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([
    'video_url' => '<string>',
    'caption_setting' => [
        'style' => 'normal-black',
        'offset' => [
                'x' => 0,
                'y' => 0.4
        ],
        'font_family' => 'Montserrat',
        'font_size' => 70,
        '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
    ],
    'background_music_url' => '<string>',
    'background_music_volume' => 0.5,
    'voiceover_volume' => 0.5,
    'webhook_url' => '<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/ai_editing/preview/"

	payload := strings.NewReader("{\n  \"video_url\": \"<string>\",\n  \"caption_setting\": {\n    \"style\": \"normal-black\",\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_family\": \"Montserrat\",\n    \"font_size\": 70,\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  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<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/ai_editing/preview/")
  .header("X-API-ID", "<api-key>")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"<string>\",\n  \"caption_setting\": {\n    \"style\": \"normal-black\",\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_family\": \"Montserrat\",\n    \"font_size\": 70,\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  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"video_url\": \"<string>\",\n  \"caption_setting\": {\n    \"style\": \"normal-black\",\n    \"offset\": {\n      \"x\": 0,\n      \"y\": 0.4\n    },\n    \"font_family\": \"Montserrat\",\n    \"font_size\": 70,\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  \"background_music_url\": \"<string>\",\n  \"background_music_volume\": 0.5,\n  \"voiceover_volume\": 0.5,\n  \"webhook_url\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failed_reason": "<string>",
  "video_output": "<string>",
  "preview": "<string>",
  "editor_url": "<string>",
  "is_hidden": true,
  "progress": 123,
  "credits_used": 123,
  "duration": 123,
  "media_job": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "script": "<string>",
  "is_talking_video": true,
  "is_one_person_in_video": true,
  "audio_url": "<string>",
  "video_url": "<string>",
  "size": 123,
  "created_from_api": true,
  "caption_setting": "<unknown>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "brand": "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<uri>

required

caption_setting

object | null

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

Show child attributes

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

Response

200 - application/json

string<uuid>

required

read-only

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

failed_reason

string

required

read-only

Failed reason

video_output

string | null

required

read-only

Video output URL

preview

string | null

required

read-only

Preview URL

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. , expires in 24 hours.

is_hidden

boolean

required

read-only

Is the video hidden in the website projects page

progress

number<double>

required

read-only

Progress of the job

credits_used

number

required

read-only

Credits used in this API call

duration

integer

required

read-only

Duration of the video in seconds

media_job

string | null

required

read-only

permission_type

enum<string>

required

private - Private
workspace - Workspace
public - Public

Available options:

private,

workspace,

public

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

user

integer | null

required

read-only

workspace

string<uuid> | null

required

read-only

name

string

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

audio_url

string | null

Audio to be used for the video

Maximum string length: 255

video_url

string | null

Video to be used for the video

Maximum string length: 255

size

number<double>

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

brand

string<uuid> | null

Create a AI Editing task Render a AI Editing video

⌘I

​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