Skip to main content
GET
/
avatars
/
{seed}
Get Agent Avatar
curl --request GET \
  --url https://api.veryfront.com/avatars/{seed} \
  --header 'Authorization: Bearer <token>'
{
  "seed": "<string>",
  "name": "<string>",
  "archetype": "upright",
  "tags": [
    "<string>"
  ],
  "avatar": {
    "shape": "snircle",
    "layers": [
      {
        "type": "background",
        "color": {
          "id": "<string>",
          "hex": "<string>"
        }
      }
    ]
  },
  "url": "<string>",
  "requested_archetype": "upright"
}

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

​
seed
string
required

Deterministic avatar seed.

Required string length: 1 - 128

Query Parameters

​
size
integer

SVG intrinsic width in pixels.

Required range: 32 <= x <= 1024
​
matrix
string

4x4 avatar matrix encoded row-major. 0 hides a dot, 1 draws a light dot, 2 draws a dark eye dot.

Pattern: ^[012]{16}$
​
texture
string

Bundled 400x400 avatar texture id (0-8).

Pattern: ^[0-8]$
​
color
string

Avatar background color as a 6-digit hex value.

Pattern: ^#[0-9a-fA-F]{6}$
​
shape
enum<string>

Avatar outer shape.

Available options:
snircle,
circle,
square
​
archetype
enum<string>

Semantic archetype used for shape, color association, names, and tags.

Available options:
upright,
slumped,
alert,
profile,
leaning,
crouched,
tall,
spread,
happy,
sad,
angry,
surprised,
sleepy,
curious
​
prompt
string

Natural language prompt classified through the Veryfront AI Gateway when an explicit archetype is not provided.

Required string length: 1 - 1000

Response

Resolved avatar metadata or SVG avatar markup

​
seed
string
required
​
name
string
required
​
archetype
enum<string>
required
Available options:
upright,
slumped,
alert,
profile,
leaning,
crouched,
tall,
spread,
happy,
sad,
angry,
surprised,
sleepy,
curious
​
tags
string[]
required
​
avatar
object
required
​
url
string
required
​
requested_archetype
enum<string>
Available options:
upright,
slumped,
alert,
profile,
leaning,
crouched,
tall,
spread,
happy,
sad,
angry,
surprised,
sleepy,
curious