Skip to main content
POST
/
api
/
personas_v2
/
cURL
curl --request POST \
  --url https://api.creatify.ai/api/personas_v2/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "creator_name": "<string>",
  "video_scene": "<string>",
  "keywords": "<string>",
  "lipsync_input": "<string>",
  "gdown_url": "<string>",
  "labels": [
    "<string>"
  ],
  "webhook_url": "<string>"
}
'
import requests

url = "https://api.creatify.ai/api/personas_v2/"

payload = {
"creator_name": "<string>",
"video_scene": "<string>",
"keywords": "<string>",
"lipsync_input": "<string>",
"gdown_url": "<string>",
"labels": ["<string>"],
"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({
creator_name: '<string>',
video_scene: '<string>',
keywords: '<string>',
lipsync_input: '<string>',
gdown_url: '<string>',
labels: ['<string>'],
webhook_url: '<string>'
})
};

fetch('https://api.creatify.ai/api/personas_v2/', 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/personas_v2/",
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([
'creator_name' => '<string>',
'video_scene' => '<string>',
'keywords' => '<string>',
'lipsync_input' => '<string>',
'gdown_url' => '<string>',
'labels' => [
'<string>'
],
'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/personas_v2/"

payload := strings.NewReader("{\n \"creator_name\": \"<string>\",\n \"video_scene\": \"<string>\",\n \"keywords\": \"<string>\",\n \"lipsync_input\": \"<string>\",\n \"gdown_url\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\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/personas_v2/")
.header("X-API-ID", "<api-key>")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"creator_name\": \"<string>\",\n \"video_scene\": \"<string>\",\n \"keywords\": \"<string>\",\n \"lipsync_input\": \"<string>\",\n \"gdown_url\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"creator_name\": \"<string>\",\n \"video_scene\": \"<string>\",\n \"keywords\": \"<string>\",\n \"lipsync_input\": \"<string>\",\n \"gdown_url\": \"<string>\",\n \"labels\": [\n \"<string>\"\n ],\n \"webhook_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creator_name": "<string>",
  "consent_video": "<string>",
  "lipsync_input_url": "<string>",
  "matching_voice_non_null": "<string>",
  "failed_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "video_scene": "<string>",
  "keywords": "<string>",
  "lipsync_input": "<string>",
  "gdown_url": "<string>",
  "labels": [
    "<string>"
  ],
  "webhook_url": "<string>"
}

Quick Start Guide

Bring Your Own Avatar

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

gender
enum<string>
required

gender of the persona

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
creator_name
string
required

Name of the persona, used to identify the real person, not for display

Maximum string length: 255
video_scene
string | null

A word to describe the background setting. API user rely on this

Maximum string length: 255
keywords
string | null

keywords (comma separated)

Maximum string length: 255
lipsync_input
string<uri>
gdown_url
string<uri>
labels
string[]
original_voice_provider
enum<string>

Provider that minted original_voice_provider_id (paired cache field). Default ELEVENLABS is correct for pre-Workstream-C rows whose cache could only ever hold 11labs ids.

  • elevenlabs - ElevenLabs
  • minimax - MiniMax
  • fishaudio - FishAudio
Available options:
elevenlabs,
minimax,
fishaudio
webhook_url
string<uri> | null

Webhook url, when the creator is created, we will send a webhook to the url(only for api user)

Maximum string length: 200

Response

201 - application/json
id
string<uuid>
required
read-only
gender
enum<string>
required

gender of the persona

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
creator_name
string
required

Name of the persona, used to identify the real person, not for display

Maximum string length: 255

The URL of the consent video

lipsync_input_url
string
required
read-only
matching_voice_non_null
string
required
read-only
process_status
enum<string>
required

The status of creating process of the creator, if not done, it should not be shown in the UI

  • pending - Pending
  • processing - Processing
  • voice_creating - Voice Creating
  • video_validating - Video Validating
  • crop_and_matte - Crop And Matte
  • reviewing - Reviewing
  • done - Done
  • failed - Failed
  • rejected - Rejected
Available options:
pending,
processing,
voice_creating,
video_validating,
crop_and_matte,
reviewing,
done,
failed,
rejected
failed_reason
string | null
required
read-only

The reason why the creator creation failed, if not failed, it should be empty

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
video_scene
string | null

A word to describe the background setting. API user rely on this

Maximum string length: 255
keywords
string | null

keywords (comma separated)

Maximum string length: 255
lipsync_input
string<uri>
gdown_url
string<uri>
labels
string[]
original_voice_provider
enum<string>

Provider that minted original_voice_provider_id (paired cache field). Default ELEVENLABS is correct for pre-Workstream-C rows whose cache could only ever hold 11labs ids.

  • elevenlabs - ElevenLabs
  • minimax - MiniMax
  • fishaudio - FishAudio
Available options:
elevenlabs,
minimax,
fishaudio
webhook_url
string<uri> | null

Webhook url, when the creator is created, we will send a webhook to the url(only for api user)

Maximum string length: 200