cURL
curl --request GET \
--url https://api.creatify.ai/api/lipsyncs/{id}/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/lipsyncs/{id}/"
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-ID': '<api-key>', 'X-API-KEY': '<api-key>'}};
fetch('https://api.creatify.ai/api/lipsyncs/{id}/', 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/lipsyncs/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/lipsyncs/{id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.creatify.ai/api/lipsyncs/{id}/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/lipsyncs/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"output": "<string>",
"video_thumbnail": "<string>",
"aspect_ratio": "16x9",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"credits_used": 123,
"duration": 123,
"progress": "<string>",
"failed_reason": "<string>",
"media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"is_hidden": true,
"audio_url": "<string>",
"preview": "<string>",
"editor_url": "<string>",
"preview_audio": "<string>",
"word_alignments": [
{
"start": 123,
"duration": 123,
"text": "<string>"
}
],
"name": "<string>",
"text": "<string>",
"creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"model_version": "standard",
"green_screen": true,
"transparent_background": true,
"webhook_url": "<string>",
"accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"no_caption": true,
"no_music": true,
"caption_style": "normal-black",
"caption_offset_x": "<string>",
"caption_offset_y": "<string>"
}API Reference (v1)
Get AI Avatar item by id
Mixin to provide a reusable list method for filtering and paginating queryset results.
GET
/
api
/
lipsyncs
/
{id}
/
cURL
curl --request GET \
--url https://api.creatify.ai/api/lipsyncs/{id}/ \
--header 'X-API-ID: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.creatify.ai/api/lipsyncs/{id}/"
headers = {
"X-API-ID": "<api-key>",
"X-API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-ID': '<api-key>', 'X-API-KEY': '<api-key>'}};
fetch('https://api.creatify.ai/api/lipsyncs/{id}/', 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/lipsyncs/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.creatify.ai/api/lipsyncs/{id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-ID", "<api-key>")
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.creatify.ai/api/lipsyncs/{id}/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.creatify.ai/api/lipsyncs/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-ID"] = '<api-key>'
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"output": "<string>",
"video_thumbnail": "<string>",
"aspect_ratio": "16x9",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"credits_used": 123,
"duration": 123,
"progress": "<string>",
"failed_reason": "<string>",
"media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"is_hidden": true,
"audio_url": "<string>",
"preview": "<string>",
"editor_url": "<string>",
"preview_audio": "<string>",
"word_alignments": [
{
"start": 123,
"duration": 123,
"text": "<string>"
}
],
"name": "<string>",
"text": "<string>",
"creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"model_version": "standard",
"green_screen": true,
"transparent_background": true,
"webhook_url": "<string>",
"accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"no_caption": true,
"no_music": true,
"caption_style": "normal-black",
"caption_offset_x": "<string>",
"caption_offset_y": "<string>"
}Authorizations
Response
200 - application/json
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
Available options:
standard, aurora_v1, aurora_v1_fast, boreal, aurora_v2 The style of the captions
normal-black- NORMAL_BLACKnormal-white- NORMAL_WHITEnormal-red- NORMAL_REDnormal-blue- NORMAL_BLUEneo- NEObrick- BRICKfrenzy- FRENZYverana- VERANAmustard- MUSTARDglow- GLOWmint- MINTcoolers- COOLERSbilo- BILOtoons- TOONSdeep-blue- DEEP_BLUEmystique- MYSTIQUEcaution- CAUTIONduality- DUALITYcomic-shadow- COMIC_SHADOWclean-bold- CLEAN_BOLDsoft-pill- SOFT_PILLunderline-bold- UNDERLINE_BOLDclassic-duo- CLASSIC_DUOhand-script- HAND_SCRIPTbutton-glow- BUTTON_GLOWemboss-outline- EMBOSS_OUTLINEstandard-bold- STANDARD_BOLDoutlined-text- OUTLINED_TEXTquiet-serif- QUIET_SERIFeditorial-clean- EDITORIAL_CLEANshout-block- SHOUT_BLOCKword-flash- WORD_FLASHpromo-punch- PROMO_PUNCHlight-word- LIGHT_WORDtagline-bold- TAGLINE_BOLDglow-speak- GLOW_SPEAKblack-block- BLACK_BLOCKzoom-punch- ZOOM_PUNCH
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, comic-shadow, clean-bold, soft-pill, underline-bold, classic-duo, hand-script, button-glow, emboss-outline, standard-bold, outlined-text, quiet-serif, editorial-clean, shout-block, word-flash, promo-punch, light-word, tagline-bold, glow-speak, black-block, zoom-punch 
