curl --request POST \
--url https://api.creatify.ai/api/custom_template_jobs/preview/ \
--header 'Content-Type: application/json' \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"name": "<string>",
"webhook_url": "<string>",
"is_hidden": false
}
'import requests
url = "https://api.creatify.ai/api/custom_template_jobs/preview/"
payload = {
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"name": "<string>",
"webhook_url": "<string>",
"is_hidden": False
}
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({
template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {},
name: '<string>',
webhook_url: '<string>',
is_hidden: false
})
};
fetch('https://api.creatify.ai/api/custom_template_jobs/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/custom_template_jobs/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([
'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variables' => [
],
'name' => '<string>',
'webhook_url' => '<string>',
'is_hidden' => false
]),
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/custom_template_jobs/preview/"
payload := strings.NewReader("{\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"is_hidden\": false\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/custom_template_jobs/preview/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"is_hidden\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/custom_template_jobs/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 \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"is_hidden\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"variables": {},
"media_job": "<string>",
"video_output": "<string>",
"preview": "<string>",
"editor_url": "<string>",
"failed_reason": "<string>",
"credits_used": 123,
"duration": 123,
"status": "pending",
"progress": 123,
"name": "<string>",
"webhook_url": "<string>",
"model_version": "standard",
"is_hidden": false
}Generate Preview of Custom Template Video
This endpoint generates a preview before rendering the final video. Generating a preview through this endpoint costs 1 credit for every 30 seconds.
curl --request POST \
--url https://api.creatify.ai/api/custom_template_jobs/preview/ \
--header 'Content-Type: application/json' \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"name": "<string>",
"webhook_url": "<string>",
"is_hidden": false
}
'import requests
url = "https://api.creatify.ai/api/custom_template_jobs/preview/"
payload = {
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"name": "<string>",
"webhook_url": "<string>",
"is_hidden": False
}
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({
template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {},
name: '<string>',
webhook_url: '<string>',
is_hidden: false
})
};
fetch('https://api.creatify.ai/api/custom_template_jobs/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/custom_template_jobs/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([
'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variables' => [
],
'name' => '<string>',
'webhook_url' => '<string>',
'is_hidden' => false
]),
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/custom_template_jobs/preview/"
payload := strings.NewReader("{\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"is_hidden\": false\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/custom_template_jobs/preview/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"is_hidden\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/custom_template_jobs/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 \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"name\": \"<string>\",\n \"webhook_url\": \"<string>\",\n \"is_hidden\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"variables": {},
"media_job": "<string>",
"video_output": "<string>",
"preview": "<string>",
"editor_url": "<string>",
"failed_reason": "<string>",
"credits_used": 123,
"duration": 123,
"status": "pending",
"progress": 123,
"name": "<string>",
"webhook_url": "<string>",
"model_version": "standard",
"is_hidden": false
}About preview Field in the Response
The preview field provides a link to preview the video. This link allows you to preview the video before rendering it, you can put it in an iframe to show the video in your application. Example: The preview field in the response will look like this:"https://app.creatify.ai/preview?layout=videos/20241024/f0c1e1f1-be05-48e0-91d8-3d26ed633d5b.json"
Authorizations
Body
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- Standardaurora_v1- Aurora v1aurora_v1_fast- Aurora v1 Fastboreal- Borealaurora_v2- Aurora v2
standard, aurora_v1, aurora_v1_fast, boreal, aurora_v2 Response
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- Standardaurora_v1- Aurora v1aurora_v1_fast- Aurora v1 Fastboreal- Borealaurora_v2- Aurora v2
standard, aurora_v1, aurora_v1_fast, boreal, aurora_v2 
