Skip to main content
POST
/
api
/
personas
/
cURL
curl --request POST \
  --url https://api.creatify.ai/api/personas/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "gender": "m",
  "creator_name": "<string>",
  "video_scene": "<string>",
  "keywords": "<string>",
  "lipsync_input": "<string>",
  "gdown_url": "<string>",
  "consent_video": "<string>",
  "labels": [
    "<string>"
  ],
  "webhook_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "gender": "m",
  "creator_name": "<string>",
  "video_scene": "<string>",
  "keywords": "<string>",
  "lipsync_input": "<string>",
  "gdown_url": "<string>",
  "consent_video": "<string>",
  "lipsync_input_url": "<string>",
  "labels": [
    "<string>"
  ],
  "matching_voice_non_null": "<string>",
  "process_status": "pending",
  "failed_reason": "<string>",
  "webhook_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
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 length: 255
​
video_scene
string | null

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

Maximum length: 255
​
keywords
string | null

keywords (comma separated)

Maximum length: 255
​
lipsync_input
string<uri>
​
gdown_url
string<uri>
​
consent_video
string<uri> | null

The URL of the consent video

Maximum length: 200
​
labels
string[]
​
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 length: 200

Response

201 - application/json
​
id
string<uuid>
required
​
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 length: 255
​
lipsync_input_url
string
required
​
matching_voice_non_null
string
required
​
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

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

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

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

Maximum length: 255
​
keywords
string | null

keywords (comma separated)

Maximum length: 255
​
lipsync_input
string<uri>
​
gdown_url
string<uri>
​
consent_video
string<uri> | null

The URL of the consent video

Maximum length: 200
​
labels
string[]
​
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 length: 200