Parameters
Customize avatars with subjects, themes, and colors.
Avatar Parameters
Customize your avatar with subjects, themes, gender, and background color.
Required Parameters
Every avatar request requires these four parameters:
{
"parameters": {
"subject": "fox",
"theme": "astronaut",
"gender": "neutral",
"color": "orange"
}
}
Subject
The character type to generate.
| Subject | Description |
|---|---|
fox | Fox character |
cat | Cat character |
dog | Dog character |
owl | Owl character |
bear | Bear character |
raccoon | Raccoon character |
penguin | Penguin character |
robot | Robot character |
{ "parameters": { "subject": "owl" } }
Theme
The role, costume, or occupation.
| Theme | Description |
|---|---|
astronaut | Space explorer |
scientist | Lab coat and goggles |
chef | Kitchen attire |
doctor | Medical professional |
detective | Mystery solver |
firefighter | Emergency responder |
artist | Creative attire |
musician | Performance outfit |
{ "parameters": { "theme": "scientist" } }
Gender
Gender presentation of the character.
| Gender | Description |
|---|---|
male | Masculine presentation |
female | Feminine presentation |
neutral | Non-gendered presentation |
{ "parameters": { "gender": "neutral" } }
Color
Background color (pastel tones).
| Color | Hex |
|---|---|
red | #F7D6D0 |
orange | #F8DEC8 |
yellow | #FFF2C2 |
green | #DFF3E0 |
blue | #D8EAFB |
indigo | #E0E3FA |
violet | #EEDCF7 |
purple | #E6D7F3 |
pink | #F9DDE6 |
beige | #F2E8D5 |
{ "parameters": { "color": "blue" } }
Complete Examples
Friendly Mascot
{
"style_id": "cartoon_flat_modern",
"quality": "standard",
"size": "square",
"parameters": {
"subject": "owl",
"theme": "scientist",
"gender": "neutral",
"color": "purple"
}
}
Gaming Avatar
{
"style_id": "pixel_art_8bit",
"quality": "standard",
"size": "square",
"parameters": {
"subject": "robot",
"theme": "astronaut",
"gender": "neutral",
"color": "blue"
}
}
Kids App Character
{
"style_id": "storybook_soft",
"quality": "standard",
"size": "square",
"parameters": {
"subject": "bear",
"theme": "chef",
"gender": "neutral",
"color": "orange"
}
}
Comic Style Hero
{
"style_id": "comic_marvel_vintage",
"quality": "high",
"size": "portrait",
"parameters": {
"subject": "cat",
"theme": "detective",
"gender": "female",
"color": "indigo"
}
}
Validation
Invalid parameters return a 400 error:
{
"statusCode": 400,
"message": "Parameter validation failed: subject 'unicorn' is not valid"
}