GET
/
api
/
personas

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.

Response

200 - application/json
​
created_at
string
required
​
creator_name
string
required
​
failed_reason
string
required
​
gender
enum<string>
required

gender of the persona

  • m - Male
  • f - Female
  • nb - Non Binary
Available options:
m,
f,
nb
​
id
string
required
​
is_active
boolean
required

Is the creator active to use, if not, it will not be shown in the UI

​
landscape_preview_video
string | null
required

Landscape preview video of the persona

​
preview_image_1_1
string | null
required
​
preview_image_16_9
string | null
required
​
preview_image_9_16
string | null
required
​
preview_video_1_1
string | null
required
​
preview_video_16_9
string | null
required
​
preview_video_9_16
string | null
required
​
process_status
string
required
​
squared_preview_video
string | null
required

Squared preview video of the persona

​
type
string
required
​
updated_at
string
required
​
keywords
string | null

keywords (comma separated)

Maximum length: 255
​
video_scene
string | null

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

Maximum length: 255
Get AI Editing item by idGet all Custom Avatars that are created by your account