API Service

Generate unique, deterministic avatars via our REST API

Endpoint

All avatars are generated through a single GET endpoint

GEThttps://your-domain.com/api/avatar

Parameters

All parameters are optional. If not provided, defaults will be used.

namestring

The name used to generate a unique avatar. Can be any string - username, email, uuid, etc.

Default: default

variantstring

The avatar style variant

marblebeampixelsunsetringbauhausfractalmagebarcodepepe

Default: marble

sizenumber

Size of the avatar in pixels (width and height)

Default: 80

colorsstring

Comma-separated list of hex colors (without #). Example: 264653,2a9d8f,e9c46a

Default: default palette

formatstring

Output format for the avatar

svgpngwebp

Default: svg

Company Name

Simple avatar with default settings

API URL

React Component

Response

The API returns an SVG image directly

Content-Type: image/svg+xml

Cache-Control: public, max-age=31536000, immutable

Usage in HTML: