POST
/
pub
/
v1
/
characters

Headers

X-API-KEY
string
required

API key needed to access our public endpoints. You can find yours under the 'Account' section of the website

Body

application/json
asset_id
string
required

The asset_id of the image which you want to use as the character’s face image.

character_type
enum<string>
required

Specify if the character’s face image passed in the asset_id is a realistic image or a stylized image. A ‘stylized’ image can refer to an illustration, drawing, digital render, or any other non-photographic style.

Available options:
realistic,
stylized
name
string
required

The name of the character which is unique from all your other characters

prompt
string
required

A short description of the character’s most important features. This can include gender, age, race/ethnicity, and body type. Avoid describing clothing and background since those have to be mentioned in the prompt while generating images.

Response

201 - application/json
data
object
err
object

The error if the request was not successful