Render or retrieve a public preset agent portrait
GET
/api/agent-avatars/{version}/{palette}/{file}No API key
Render or retrieve a public preset agent portrait.
On-demand PNG artwork; no agent or organization lookup. Logical size determines face detail independently of density. View defaults to front; portrait tilts the character upward and slightly to the side for larger card artwork. Background defaults to transparent; veyra-dark supplies the opaque Veyra Intelligence dark-mode background for Slack exports. Successful URLs are immutable for one year and return a content-derived ETag. Cache entries regenerate after deletion.
Authorization
No API key is needed: the token or id in the path, or the request's own signature, authenticates the call. How keys work.
Path parameters
versionstringRequiredThe version's id.
one of: "cap-v1"palettestringRequiredThe version's id.
one of: "bubblegum-sky", "pink-lemonade", "orchid-peach", "coral-mint", "lime-lagoon", "arctic-blue", "solar-flare", "violet-ember", "deep-tide", "coral-current", "golden-hour", "tangerine-cobalt", "electric-grove", "flamingo-jade", "cherry-pop", "turquoise-cherry", "ultraviolet-tide", "muted-dream"filestringRequiredThe palette's id.
one of: "rest.png", "idle.png", "listening.png", "thinking.png", "working.png", "success.png", "confused.png", "sleepy.png", "loading.png"Query parameters
sizestringOptional
one of: "16", "20", "24", "32", "40", "48", "64", "96", "128", "256", "512"scalestringOptional
one of: "1", "2"backgroundstringOptional
one of: "transparent", "veyra-dark"viewstringOptional
one of: "front", "portrait"Responses
200PNG portrait; Cache-Control: public, max-age=31536000, immutable; ETag: SHA-256 of PNG bytesThe request worked; the body holds the result.
304If-None-Match matches the cached content ETag
400Bad requestThe request is malformed or failed validation.
details names each field that failed.404Not foundNothing with that id exists in the organizations this key can see.
429Cold-render admission limit for this client; Cache-Control: no-store; Retry-After in seconds. Cached portraits remain available.Too many requests; wait for
Retry-After seconds.503Retryable rendering/storage failure; Cache-Control: no-store; Retry-After: 5A dependency is unavailable; retry with backoff.
Errors return {"error": "..."}, often with a code and details. See errors and limits.