Skip to main content
POST
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.

Body

name
string
required

The name of the fully synthetic avatar.

age_group
enum<string>
required

The age group of the avatar.

  • infant - infant
  • child - child
  • teen - teen
  • young_adult - young_adult
  • early_middle_age - early_middle_age
  • late_middle_age - late_middle_age
  • senior - senior
Available options:
infant,
child,
teen,
young_adult,
early_middle_age,
late_middle_age,
senior
gender
enum<string>
required

The gender of the avatar.

  • m - m
  • f - f
  • nb - nb
Available options:
m,
f,
nb
more_details
string
required

Additional details about the avatar.

outfit_description
string
required

Description of the outfit of the avatar.

background_description
string
required

Description of the background of the avatar.

Response

201 - application/json
id
string<uuid>
required
read-only
user
integer | null
required
read-only
workspace
string<uuid> | null
required
read-only
name
string
required

The name of the avatar

Maximum string length: 255
photos
object[]
required
read-only
reviews
object[]
required
read-only
status
enum<string>
required

The status of the avatar

  • initializing - Initializing
  • draft - Draft
  • pending - Pending
  • in_progress - In Progress
  • done - Done
  • rejected - Rejected
Available options:
initializing,
draft,
pending,
in_progress,
done,
rejected
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
age_group

Age Group

  • infant - 0 to 5 years old
  • child - 5 to 12 years old
  • teen - 13 to 19 years old
  • young_adult - 20 to 34 years old
  • early_middle_age - 35 to 44 years old
  • late_middle_age - 45 to 54 years old
  • senior - 55 years old and above
Available options:
infant,
child,
teen,
young_adult,
early_middle_age,
late_middle_age,
senior
gender

Gender

  • m - Male
  • f - Female
  • nb - Non-Binary
Available options:
m,
f,
nb
more_details
string | null

More Details of avatar

outfit_description
string | null

Description of the avatar's outfit

background_description
string | null

Description of the avatar's background