Skip to main content
GET
/
api
/
personas_v2
cURL
curl --request GET \
  --url https://api.creatify.ai/api/personas_v2/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "gender": "m",
    "creator_name": "<string>",
    "suitable_industries": "<string>",
    "preview_image_16_9": "<string>",
    "preview_image_1_1": "<string>",
    "preview_image_9_16": "<string>",
    "preview_video_16_9": "<string>",
    "preview_video_1_1": "<string>",
    "preview_video_9_16": "<string>",
    "landscape_preview_video": "<string>",
    "squared_preview_video": "<string>",
    "portrait_preview_video": "<string>",
    "is_active": true,
    "process_status": "<string>",
    "failed_reason": "<string>",
    "type": "<string>",
    "age_range": "child",
    "location": "outdoor",
    "style": "selfie",
    "video_scene": "<string>",
    "keywords": "<string>"
  }
]

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.

Query Parameters

​
age_range
enum<string>

Filter by age range

  • child - Child
  • teen - Teen
  • adult - Adult
  • senior - Senior
Available options:
child,
teen,
adult,
senior
Minimum string length: 1
​
gender
enum<string>

Filter by gender

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
Minimum string length: 1
​
location
enum<string>

Filter by location

  • outdoor - Outdoor
  • fantasy - Fantasy
  • indoor - Indoor
  • other - Other
Available options:
outdoor,
fantasy,
indoor,
other
Minimum string length: 1
​
style
enum<string>

Filter by style

  • selfie - Selfie
  • presenter - Presenter
  • other - Other
Available options:
selfie,
presenter,
other
Minimum string length: 1

Response

200 - application/json
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
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
​
suitable_industries
string
required
​
preview_image_16_9
string | null
required
​
preview_image_1_1
string | null
required
​
preview_image_9_16
string | null
required
​
preview_video_16_9
string | null
required
​
preview_video_1_1
string | null
required
​
preview_video_9_16
string | null
required
​
landscape_preview_video
string<uri> | null
required

Landscape preview video of the persona

​
squared_preview_video
string<uri> | null
required

Squared preview video of the persona

​
portrait_preview_video
string<uri> | null
required

Portrait preview video of the persona

​
is_active
boolean
required

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

​
process_status
string
required
​
failed_reason
string
required
​
type
string
required
​
age_range
enum<string>

age range of the persona

  • child - Child
  • teen - Teen
  • adult - Adult
  • senior - Senior
Available options:
child,
teen,
adult,
senior
​
location
enum<string>

location of the persona

  • outdoor - Outdoor
  • fantasy - Fantasy
  • indoor - Indoor
  • other - Other
Available options:
outdoor,
fantasy,
indoor,
other
​
style
enum<string>

style of the persona

  • selfie - Selfie
  • presenter - Presenter
  • other - Other
Available options:
selfie,
presenter,
other
​
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