Create a render directly from a video json
curl --request POST \
--url https://api.videoaiditor.com/v1/renders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
}
},
"clips": [
{
"source": "<string>",
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"name": "<string>",
"volume": 1
}
],
"autoGenerateCaptionWords": false,
"captionLanguageCode": "en-US",
"renderOptionsInUI": [],
"additional": {}
}
'import requests
url = "https://api.videoaiditor.com/v1/renders"
payload = {
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
}
},
"clips": [
{
"source": "<string>",
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"name": "<string>",
"volume": 1
}
],
"autoGenerateCaptionWords": False,
"captionLanguageCode": "en-US",
"renderOptionsInUI": [],
"additional": {}
}
headers = {
"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-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {
name: '<string>',
backgroundColor: '#000000',
duration: 123,
fps: 30,
canvas: {width: 1920, height: 1080}
},
clips: [
{
source: '<string>',
timeFrame: {start: 0, end: 123, offset: 123},
position: {x: 0, y: 0, z: 0},
transform: {scale: {x: 1, y: 1}, rotation: 123},
size: {width: 100, height: 100},
name: '<string>',
volume: 1
}
],
autoGenerateCaptionWords: false,
captionLanguageCode: 'en-US',
renderOptionsInUI: [],
additional: {}
})
};
fetch('https://api.videoaiditor.com/v1/renders', 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.videoaiditor.com/v1/renders",
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([
'metadata' => [
'name' => '<string>',
'backgroundColor' => '#000000',
'duration' => 123,
'fps' => 30,
'canvas' => [
'width' => 1920,
'height' => 1080
]
],
'clips' => [
[
'source' => '<string>',
'timeFrame' => [
'start' => 0,
'end' => 123,
'offset' => 123
],
'position' => [
'x' => 0,
'y' => 0,
'z' => 0
],
'transform' => [
'scale' => [
'x' => 1,
'y' => 1
],
'rotation' => 123
],
'size' => [
'width' => 100,
'height' => 100
],
'name' => '<string>',
'volume' => 1
]
],
'autoGenerateCaptionWords' => false,
'captionLanguageCode' => 'en-US',
'renderOptionsInUI' => [
],
'additional' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.videoaiditor.com/v1/renders"
payload := strings.NewReader("{\n \"metadata\": {\n \"name\": \"<string>\",\n \"backgroundColor\": \"#000000\",\n \"duration\": 123,\n \"fps\": 30,\n \"canvas\": {\n \"width\": 1920,\n \"height\": 1080\n }\n },\n \"clips\": [\n {\n \"source\": \"<string>\",\n \"timeFrame\": {\n \"start\": 0,\n \"end\": 123,\n \"offset\": 123\n },\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"transform\": {\n \"scale\": {\n \"x\": 1,\n \"y\": 1\n },\n \"rotation\": 123\n },\n \"size\": {\n \"width\": 100,\n \"height\": 100\n },\n \"name\": \"<string>\",\n \"volume\": 1\n }\n ],\n \"autoGenerateCaptionWords\": false,\n \"captionLanguageCode\": \"en-US\",\n \"renderOptionsInUI\": [],\n \"additional\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.videoaiditor.com/v1/renders")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"name\": \"<string>\",\n \"backgroundColor\": \"#000000\",\n \"duration\": 123,\n \"fps\": 30,\n \"canvas\": {\n \"width\": 1920,\n \"height\": 1080\n }\n },\n \"clips\": [\n {\n \"source\": \"<string>\",\n \"timeFrame\": {\n \"start\": 0,\n \"end\": 123,\n \"offset\": 123\n },\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"transform\": {\n \"scale\": {\n \"x\": 1,\n \"y\": 1\n },\n \"rotation\": 123\n },\n \"size\": {\n \"width\": 100,\n \"height\": 100\n },\n \"name\": \"<string>\",\n \"volume\": 1\n }\n ],\n \"autoGenerateCaptionWords\": false,\n \"captionLanguageCode\": \"en-US\",\n \"renderOptionsInUI\": [],\n \"additional\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.videoaiditor.com/v1/renders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"name\": \"<string>\",\n \"backgroundColor\": \"#000000\",\n \"duration\": 123,\n \"fps\": 30,\n \"canvas\": {\n \"width\": 1920,\n \"height\": 1080\n }\n },\n \"clips\": [\n {\n \"source\": \"<string>\",\n \"timeFrame\": {\n \"start\": 0,\n \"end\": 123,\n \"offset\": 123\n },\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"transform\": {\n \"scale\": {\n \"x\": 1,\n \"y\": 1\n },\n \"rotation\": 123\n },\n \"size\": {\n \"width\": 100,\n \"height\": 100\n },\n \"name\": \"<string>\",\n \"volume\": 1\n }\n ],\n \"autoGenerateCaptionWords\": false,\n \"captionLanguageCode\": \"en-US\",\n \"renderOptionsInUI\": [],\n \"additional\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"_id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"outputUrl": "<string>",
"videoId": "<string>",
"error": "<string>",
"videoData": {
"_id": "<string>",
"version": "<string>",
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
},
"redirectUrl": "<string>"
},
"clips": [
{
"source": "<string>",
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"id": "<string>",
"name": "<string>",
"volume": 1,
"textProperties": {
"content": "<string>",
"fontSize": 16,
"fontWeight": 400,
"fontFamily": "Arial",
"color": "#000000",
"backgroundColor": "transparent",
"textAlign": "left",
"fontStyle": "normal",
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"underline": false
},
"captionProperties": {
"words": [
{
"start": 123,
"end": 123,
"word": "<string>"
}
],
"highlightTextProperties": {
"fontSize": 24,
"color": "#000000",
"fontFamily": "Montserrat",
"fontWeight": 400,
"fontStyle": "normal",
"underline": false,
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"backgroundColor": "<string>"
},
"nonHighlightTextProperties": {
"fontSize": 24,
"color": "#000000",
"fontFamily": "Montserrat",
"fontWeight": 400,
"fontStyle": "normal",
"underline": false,
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"backgroundColor": "<string>"
},
"textAlign": "center",
"maxWidth": 500,
"maxWordsInFrame": 5
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"additional": {}
}
}
}{
"statusCode": 400,
"message": [
"Invalid input",
"Missing required field"
],
"error": "Bad Request"
}{
"statusCode": 401,
"message": [
"Invalid credentials",
"Token expired"
],
"error": "Unauthorized"
}{
"statusCode": 403,
"message": [
"Access denied",
"Insufficient permissions"
],
"error": "Forbidden"
}{
"statusCode": 404,
"message": [
"Resource not found"
],
"error": "Not Found"
}Render Endpoints
Create Render
POST
/
v1
/
renders
Create a render directly from a video json
curl --request POST \
--url https://api.videoaiditor.com/v1/renders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
}
},
"clips": [
{
"source": "<string>",
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"name": "<string>",
"volume": 1
}
],
"autoGenerateCaptionWords": false,
"captionLanguageCode": "en-US",
"renderOptionsInUI": [],
"additional": {}
}
'import requests
url = "https://api.videoaiditor.com/v1/renders"
payload = {
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
}
},
"clips": [
{
"source": "<string>",
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"name": "<string>",
"volume": 1
}
],
"autoGenerateCaptionWords": False,
"captionLanguageCode": "en-US",
"renderOptionsInUI": [],
"additional": {}
}
headers = {
"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-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: {
name: '<string>',
backgroundColor: '#000000',
duration: 123,
fps: 30,
canvas: {width: 1920, height: 1080}
},
clips: [
{
source: '<string>',
timeFrame: {start: 0, end: 123, offset: 123},
position: {x: 0, y: 0, z: 0},
transform: {scale: {x: 1, y: 1}, rotation: 123},
size: {width: 100, height: 100},
name: '<string>',
volume: 1
}
],
autoGenerateCaptionWords: false,
captionLanguageCode: 'en-US',
renderOptionsInUI: [],
additional: {}
})
};
fetch('https://api.videoaiditor.com/v1/renders', 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.videoaiditor.com/v1/renders",
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([
'metadata' => [
'name' => '<string>',
'backgroundColor' => '#000000',
'duration' => 123,
'fps' => 30,
'canvas' => [
'width' => 1920,
'height' => 1080
]
],
'clips' => [
[
'source' => '<string>',
'timeFrame' => [
'start' => 0,
'end' => 123,
'offset' => 123
],
'position' => [
'x' => 0,
'y' => 0,
'z' => 0
],
'transform' => [
'scale' => [
'x' => 1,
'y' => 1
],
'rotation' => 123
],
'size' => [
'width' => 100,
'height' => 100
],
'name' => '<string>',
'volume' => 1
]
],
'autoGenerateCaptionWords' => false,
'captionLanguageCode' => 'en-US',
'renderOptionsInUI' => [
],
'additional' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.videoaiditor.com/v1/renders"
payload := strings.NewReader("{\n \"metadata\": {\n \"name\": \"<string>\",\n \"backgroundColor\": \"#000000\",\n \"duration\": 123,\n \"fps\": 30,\n \"canvas\": {\n \"width\": 1920,\n \"height\": 1080\n }\n },\n \"clips\": [\n {\n \"source\": \"<string>\",\n \"timeFrame\": {\n \"start\": 0,\n \"end\": 123,\n \"offset\": 123\n },\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"transform\": {\n \"scale\": {\n \"x\": 1,\n \"y\": 1\n },\n \"rotation\": 123\n },\n \"size\": {\n \"width\": 100,\n \"height\": 100\n },\n \"name\": \"<string>\",\n \"volume\": 1\n }\n ],\n \"autoGenerateCaptionWords\": false,\n \"captionLanguageCode\": \"en-US\",\n \"renderOptionsInUI\": [],\n \"additional\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.videoaiditor.com/v1/renders")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {\n \"name\": \"<string>\",\n \"backgroundColor\": \"#000000\",\n \"duration\": 123,\n \"fps\": 30,\n \"canvas\": {\n \"width\": 1920,\n \"height\": 1080\n }\n },\n \"clips\": [\n {\n \"source\": \"<string>\",\n \"timeFrame\": {\n \"start\": 0,\n \"end\": 123,\n \"offset\": 123\n },\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"transform\": {\n \"scale\": {\n \"x\": 1,\n \"y\": 1\n },\n \"rotation\": 123\n },\n \"size\": {\n \"width\": 100,\n \"height\": 100\n },\n \"name\": \"<string>\",\n \"volume\": 1\n }\n ],\n \"autoGenerateCaptionWords\": false,\n \"captionLanguageCode\": \"en-US\",\n \"renderOptionsInUI\": [],\n \"additional\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.videoaiditor.com/v1/renders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": {\n \"name\": \"<string>\",\n \"backgroundColor\": \"#000000\",\n \"duration\": 123,\n \"fps\": 30,\n \"canvas\": {\n \"width\": 1920,\n \"height\": 1080\n }\n },\n \"clips\": [\n {\n \"source\": \"<string>\",\n \"timeFrame\": {\n \"start\": 0,\n \"end\": 123,\n \"offset\": 123\n },\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"transform\": {\n \"scale\": {\n \"x\": 1,\n \"y\": 1\n },\n \"rotation\": 123\n },\n \"size\": {\n \"width\": 100,\n \"height\": 100\n },\n \"name\": \"<string>\",\n \"volume\": 1\n }\n ],\n \"autoGenerateCaptionWords\": false,\n \"captionLanguageCode\": \"en-US\",\n \"renderOptionsInUI\": [],\n \"additional\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"_id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"outputUrl": "<string>",
"videoId": "<string>",
"error": "<string>",
"videoData": {
"_id": "<string>",
"version": "<string>",
"metadata": {
"name": "<string>",
"backgroundColor": "#000000",
"duration": 123,
"fps": 30,
"canvas": {
"width": 1920,
"height": 1080
},
"redirectUrl": "<string>"
},
"clips": [
{
"source": "<string>",
"timeFrame": {
"start": 0,
"end": 123,
"offset": 123
},
"position": {
"x": 0,
"y": 0,
"z": 0
},
"transform": {
"scale": {
"x": 1,
"y": 1
},
"rotation": 123
},
"size": {
"width": 100,
"height": 100
},
"id": "<string>",
"name": "<string>",
"volume": 1,
"textProperties": {
"content": "<string>",
"fontSize": 16,
"fontWeight": 400,
"fontFamily": "Arial",
"color": "#000000",
"backgroundColor": "transparent",
"textAlign": "left",
"fontStyle": "normal",
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"underline": false
},
"captionProperties": {
"words": [
{
"start": 123,
"end": 123,
"word": "<string>"
}
],
"highlightTextProperties": {
"fontSize": 24,
"color": "#000000",
"fontFamily": "Montserrat",
"fontWeight": 400,
"fontStyle": "normal",
"underline": false,
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"backgroundColor": "<string>"
},
"nonHighlightTextProperties": {
"fontSize": 24,
"color": "#000000",
"fontFamily": "Montserrat",
"fontWeight": 400,
"fontStyle": "normal",
"underline": false,
"padding": 0,
"strokeWidth": 0,
"strokeColor": "#000000",
"borderWidth": 0,
"borderColor": "#FFFFFF",
"backgroundColor": "<string>"
},
"textAlign": "center",
"maxWidth": 500,
"maxWordsInFrame": 5
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"additional": {}
}
}
}{
"statusCode": 400,
"message": [
"Invalid input",
"Missing required field"
],
"error": "Bad Request"
}{
"statusCode": 401,
"message": [
"Invalid credentials",
"Token expired"
],
"error": "Unauthorized"
}{
"statusCode": 403,
"message": [
"Access denied",
"Insufficient permissions"
],
"error": "Forbidden"
}{
"statusCode": 404,
"message": [
"Resource not found"
],
"error": "Not Found"
}Authorizations
Enter your API key here
Body
application/json
Video data to render
Video project metadata
Show child attributes
Show child attributes
Array of clips that make up the video
Show child attributes
Show child attributes
Enable auto caption generation
Caption language code
Available options:
en, en-US Render options to display in UI. Leave empty to restrict renderer access
Available options:
json, client, server Additional custom properties
Response
The render has been successfully created.
Render data
Show child attributes
Show child attributes
⌘I