Skip to main content
POST
Create Custom Avatar

Authorizations

x-api-key
string
header
required

Body

application/json
avatar_name
string
required

Human-readable name for your custom avatar.

Example:

"my_avatar"

gender
enum<string>
required
Available options:
male,
female
Example:

"male"

input_image
string
required

Source photo as a base64 data URI. Max ~12 MB base64 (~9 MB binary).

Example:

"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."

Response

Custom avatar job accepted

id
string<uuid>
Example:

"3b6f4c8a-1234-5678-9abc-def012345678"

job_id
string
Example:

"sync-abcd-1234"

avatar_key_id
string
Example:

"a1b2c3d4e5"

avatar_id
string
Example:

"a1b2c3d4e5"

avatar_name
string
Example:

"my_avatar"

gender
string
Example:

"male"

category
string
Example:

"trugen"

status
string
Example:

"QUEUED"

is_private
boolean
Example:

true