API Reference

Generate unique avatars with a simple URL. The name is the path; every query parameter is optional.

Combine the options and copy the URL that produces what you see.

Name

Text (optional)

Style

Palette

Gradient

Shape

Pattern

avzx.vercel.app/octocat

default

Generate an avatar using just a name. The gradient is deterministically generated from the name.

https://avzx.vercel.app/vercel

nameAny string to generate a unique avatar

optional

Add initials or custom text overlay. Full names are automatically converted to initials.

https://avzx.vercel.app/john-doe?text=John Doe

nameBase name for gradient

textDisplayed text (auto-converts to JD)

optional

Choose between SVG (default, scalable) or PNG format for your avatar.

https://avzx.vercel.app/avatar?type=png

typesvg (default) or png

optional

Specify the output dimensions in pixels. Default is 120px.

https://avzx.vercel.app/avatar?size=256

sizeSize in pixels (default: 120)

optional

Override the auto-generated gradient with a specific hex color.

https://avzx.vercel.app/avatar?color=6366f1

colorHex color without #

optional

Add an emoji to your avatar for extra personality.

https://avzx.vercel.app/avatar?emoji=🚀&text=AB

emojiAny emoji character

textOptional text above emoji

Every option the endpoint accepts. Unknown values return 400.

Param	Values	Default
`name`	any string — path segment, required	—
`text`	any string, folded to initials	—
`size`	16 – 1024 (png caps at 512)	120
`type`	svg \| png	svg
`style`	gradient \| initials \| identicon \| rings \| bauhaus \| glyph	gradient
`palette`	vivid \| pastel \| earth \| mono \| neon	vivid
`shape`	circle \| square \| squircle \| hexagon	square
`rounded`	true \| false	false
`gradient`	linear \| radial \| conic \| mesh	linear
`pattern`	dots \| grid \| stripes \| noise	none
`color`	hex, without the #	auto
`emoji`	any emoji	—