Skip to main content
GET
cURL

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.

Path Parameters

id
string<uuid>
required

A UUID string identifying this Digital Human: Creator.

Response

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

Landscape preview video of the persona

squared_preview_video
string<uri> | null
required
read-only

Squared preview video of the persona

portrait_preview_video
string<uri> | null
required
read-only

Portrait preview video of the persona

is_active
boolean
required
read-only

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

process_status
string
required
read-only
failed_reason
string
required
read-only
type
string
required
read-only
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