Skip to main content
GET
Render an avatar

Path Parameters

format
enum<string>
required

Output image file extension. Portraits support JPEG, PNG, and WebP; generated variants also support SVG.

Available options:
svg,
jpg,
png,
webp

Query Parameters

seed
string
required

URL-safe deterministic seed containing at least one letter or number.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9](?:[A-Za-z0-9._~@+-]{0,126}[A-Za-z0-9])?$
variant
enum<string>
default:monogram

Visual strategy used to produce the avatar.

Available options:
identicon,
gradient,
monogram,
portrait
gender
enum<string>
default:any

Portrait catalog scope. This parameter is only valid when variant is portrait.

Available options:
any,
male,
female
size
integer
default:256

Square raster size in pixels. This parameter is only valid for JPEG, PNG, and WebP.

Required range: 16 <= x <= 1024

Response

Deterministic generated or seeded portrait avatar image.

The response is of type file.