API Reference

Generate unique avatars with a simple URL. All parameters are optional.

default

Default usage

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

Custom text

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

Output format

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

https://avzx.vercel.app/avatar?type=png
typesvg (default) or png
optional

Custom size

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

https://avzx.vercel.app/avatar?size=256
sizeSize in pixels (default: 120)
optional

Custom color

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

https://avzx.vercel.app/avatar?color=6366f1
colorHex color without #
optional

Emoji support

Add an emoji to your avatar for extra personality.

https://avzx.vercel.app/avatar?emoji=🚀&text=AB
emojiAny emoji character
textOptional text above emoji

Quick Reference

/[name]Base endpoint
?text=ABCustom initials
?size=256Output size (px)
?type=pngOutput format
?shape=circleAvatar shape
?gradient=radialGradient style