API Documentation

Avatar Generator API Reference

Endpoint

GET https://classyprofile.com/api/avatar

Returns an SVG image (image/svg+xml)

Parameters

emailRequiredEmail address for unique hash generation nameOptionalDisplay name for initials (default: from email) sizeOptional20-140px (default: 80) vOptional1-20 (default: 1) - See available styles below

Examples

Basic usage:

https://classyprofile.com/api/avatar?email=user@example.com

With name and cyberpunk style:

https://classyprofile.com/api/avatar?email=user@example.com&name=John+Doe&v=2&size=100

With gradient mesh style:

https://classyprofile.com/api/avatar?email=user@example.com&v=5&size=120

HTML implementation:

<img src="https://classyprofile.com/api/avatar?email=user@example.com"
     alt="User Avatar" width="80" height="80" />

React implementation:

function UserAvatar({ email, name, style = "1" }) {
  const params = new URLSearchParams({
    email,
    ...(name && { name }),
    v: style, // 1-20 for different styles
    size: "100"
  });

  return (
    <img
      src={`https://classyprofile.com/api/avatar?${params}`}
      alt="User Avatar"
      width={100}
      height={100}
    />
  );
}

Easy Integration

Quick examples for popular frameworks and tools:

HTML

<img src="https://classyprofile.com/api/avatar?email=user@example.com&v=2" alt="Avatar" />

React

function Avatar({ email, version = 1 }) {
  return (
    <img
      src={`https://classyprofile.com/api/avatar?email=${encodeURIComponent(email)}&v=${version}`}
      alt="Avatar"
      className="rounded-full"
    />
  );
}

Vue

<template>
  <img
    :src="`https://classyprofile.com/api/avatar?email=${encodeURIComponent(email)}&v=${version}`"
    alt="Avatar"
    class="rounded-full"
  />
</template>

cURL

curl "https://classyprofile.com/api/avatar?email=user@example.com&v=2&size=120" > avatar.svg

Response Codes

200Success - Returns SVG image

400Bad Request - Invalid parameters

Available Styles

Classic Geometric

Simple geometric shapes with vibrant colors

Cyberpunk Pixel

16x16 pixel art with neon glow effects

Minimalist Line Art

Continuous line drawings inspired by Picasso

Retro 8-bit Sprites

Classic video game character style

Gradient Mesh

Modern gradients with glass-morphism effects

ASCII Art Portraits

Text-based avatars using ASCII characters

Isometric Voxel

3D-looking cubic avatars like Minecraft

Abstract Blob Shapes

Organic fluid shapes with smooth curves

Watercolor Splash

Soft watercolor paint effects with organic blending

v10

Neon Wireframe

3D wireframe heads with glowing edges

v11

Mosaic Tiles

Byzantine/Roman mosaic style with small tiles

v12

Origami Paper

Folded paper art style with visible creases

v13

Halftone Dots

Comic book/newspaper print style

v14

Stained Glass

Cathedral window inspired with lead lines

v15

Glitch Art

Digital corruption aesthetic with RGB shifts

v16

Constellation Map

Connected star patterns forming faces

v17

Paper Cut Shadow

Layered paper cutout style with shadows

v18

Liquid Metal

Mercury/chrome flowing shapes

v19

Emoji Mosaic

Composed entirely of emoji characters

v20

Circuit Board

PCB traces forming facial features