Avatar
Generate unique avatar images on the fly. Create initial-based avatars, geometric identicons, and pixel art avatars from any string seed. Returns images directly as PNG or SVG with customizable size, colors, and rounding. Perfect for user profile placeholders, default avatars, and anonymous user identifiers.
Avatar endpoints
| Method | Endpoint | Description |
|---|---|---|
| System | ||
| GET |
healthCheck /health |
Returns the current health status of the Avatar API. This endpoint requires no authentication and is intended for uptime monitoring. |
| GET |
getDocs /v1/docs |
Returns a human-readable HTML documentation page for the Avatar API, including endpoint descriptions, parameter details, and visual examples of each avatar style. |
| Avatars | ||
| GET |
generateIdenticon /v1/identicon |
Generates a unique geometric identicon image deterministically from a seed string. Identicons are symmetric grid-based patterns commonly used in developer tools, commit avatars,… |
| GET |
generateAvatar /v1/generate |
Generates a personalized avatar image from a person's name or any text string. The avatar displays the initials of the provided name on a colored background. Supports… |
| GET |
generatePixelAvatar /v1/pixel |
Generates a unique pixel art avatar deterministically from a seed string. Pixel art avatars are colorful, retro-styled character faces inspired by 8-bit video games. Each avatar… |
| Reference | ||
| GET |
listStyles /v1/styles |
Returns a list of all available avatar generation styles with their descriptions, supported parameters, and example URLs. Useful for building UI selectors or exploring the API's… |
| Other endpoints | ||
| GET |
healthCheck /health |
Returns the current health status of the Avatar API. This endpoint requires no authentication and is intended for uptime monitoring. |
| GET |
generateIdenticon /v1/identicon |
Generates a unique geometric identicon image deterministically from a seed string. Identicons are symmetric grid-based patterns commonly used in developer tools, commit avatars,… |
| GET |
getDocs /v1/docs |
Returns a human-readable HTML documentation page for the Avatar API, including endpoint descriptions, parameter details, and visual examples of each avatar style. |
| GET |
generateAvatar /v1/generate |
Generates a personalized avatar image from a person's name or any text string. The avatar displays the initials of the provided name on a colored background. Supports… |
| GET |
generatePixelAvatar /v1/pixel |
Generates a unique pixel art avatar deterministically from a seed string. Pixel art avatars are colorful, retro-styled character faces inspired by 8-bit video games. Each avatar… |
| GET |
listStyles /v1/styles |
Returns a list of all available avatar generation styles with their descriptions, supported parameters, and example URLs. Useful for building UI selectors or exploring the API's… |
Avatar pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | 5 / minute |
|
| PRO | $9.99 / month | 30 / minute |
|
| ULTRA Recommended | $49.99 / month | 150 / minute |
|
| MEGA | $199 / month | 500 / minute |
|