Skip to main content
GET
Render a deterministic avatar

Path Parameters

style
enum<string>
required

Avatar rendering style.

Available options:
identicon,
gradient,
initials
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])?$
format
enum<string>
required

Output image file extension.

Available options:
svg,
jpg,
png,
webp

Query Parameters

size
integer

Square raster size in pixels. Defaults to 256 for JPEG, PNG, and WebP and is ignored for SVG.

Required range: 16 <= x <= 2048

Response

Deterministic avatar image.

The response is of type string.