cURL
curl --request POST \
--url https://api.creatify.ai/api/ai_editing/ \
--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/"
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/', 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/",
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/"
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/")
.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/")
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",
"status": "pending",
"failed_reason": "<string>",
"video_output": "<string>",
"preview": "<string>",
"editor_url": "<string>",
"is_hidden": true,
"progress": 123,
"credits_used": 123,
"duration": 123,
"media_job": "<string>",
"permission_type": "private",
"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>",
"aspect_ratio": "9x16",
"is_talking_video": true,
"is_one_person_in_video": true,
"editing_style": "film",
"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"
}API Reference
Create a AI Editing task
API that let AI edit your video. Creating a video through this endpoint costs 5 credits for every 30 seconds.
POST
/
api
/
ai_editing
/
cURL
curl --request POST \
--url https://api.creatify.ai/api/ai_editing/ \
--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/"
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/', 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/",
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/"
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/")
.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/")
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",
"status": "pending",
"failed_reason": "<string>",
"video_output": "<string>",
"preview": "<string>",
"editor_url": "<string>",
"is_hidden": true,
"progress": 123,
"credits_used": 123,
"duration": 123,
"media_job": "<string>",
"permission_type": "private",
"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>",
"aspect_ratio": "9x16",
"is_talking_video": true,
"is_one_person_in_video": true,
"editing_style": "film",
"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"
}Authorizations
API ID, from your settings page.
API Key, from your settings page.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
film- Filmgeometric_gradient- Geometric Gradientglitch- Glitchglitter_gradient- Glitter Gradientpaper- Paper
Available options:
film, geometric_gradient, glitch, glitter_gradient, paper Caption setting, default null and default caption setting will be used
Show child attributes
Show child attributes
Background music URL for the video. Default is null, video will use random music.
Maximum string length:
255Volume 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 <= 1Volume 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 <= 1Webhook URL for status updates. Default is null.
Maximum string length:
200Response
201 - application/json
pending- Pendingin_queue- In Queuerunning- Runningfailed- Faileddone- Donerejected- Rejected
Available options:
pending, in_queue, running, failed, done, rejected Failed reason
Video output URL
Preview URL
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 the video hidden in the website projects page
Progress of the job
Credits used in this API call
Duration of the video in seconds
private- Privateworkspace- Workspacepublic- Public
Available options:
private, workspace, public Maximum string length:
255Text to be converted to video
Aspect ratio of the video
9x16- 9X1616x9- 16X91x1- 1X1
Available options:
9x16, 16x9, 1x1 Whether the video is talking video or not
Whether the video is one person video or not
Style to be used for the video
film- Filmgeometric_gradient- Geometric Gradientglitch- Glitchglitter_gradient- Glitter Gradientpaper- Paper
Available options:
film, geometric_gradient, glitch, glitter_gradient, paper Audio to be used for the video
Maximum string length:
255Video to be used for the video
Maximum string length:
255Size of the video
Flow is created from api or not
Caption setting, default null and default caption setting will be used
Background music URL for the video. Default is null, video will use random music.
Maximum string length:
255Volume 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 <= 1Volume 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 <= 1Webhook URL for status updates. Default is null.
Maximum string length:
200