Hëllef

Benotzt hashavatar.app direkt aus dem Browser, Ärem frontend oder Ärem backend. All avatar URL ass deterministesch, also ginn dee selwechten Identifizéierer an déi selwecht Optiounen ëmmer datselwecht Resultat.

Basis URL

Benotzt de query endpoint, wann Dir eng einfach ëffentlech image URL wëllt.

https://hashavatar.app/v1/[email protected]&algorithm=sha512&kind=robot&background=white&accessory=glasses&color=gold&expression=happy&shape=circle&format=webp&size=256

Path Style URL

Benotzt d'path Form, wann Dir méi propper embed URLs léiwer hutt.

https://hashavatar.app/avatar/fox/[email protected]/webp

HTML-Beispill

<img
  src="https://hashavatar.app/v1/[email protected]&algorithm=sha512&kind=monster&background=themed&accessory=horns&color=crimson&expression=grumpy&shape=hexagon&format=webp&size=256"
  alt="Generated monster avatar"
/>

JavaScript-Beispill

const avatarUrl = new URL("https://hashavatar.app/v1/avatar");
avatarUrl.search = new URLSearchParams({
  id: user.email,
  algorithm: "sha512",
  kind: "robot",
  background: "white",
  accessory: "glasses",
  color: "gold",
  expression: "happy",
  shape: "circle",
  format: "webp",
  size: "256",
}).toString();

Ënnerstëtzt Parameteren

id: any stable identifier such as an email, username, internal user id, or one-way hash
tenant: optional namespace partition for multi-tenant apps
style_version: optional style namespace such as v2
algorithm: identity hash mode; only sha512 is supported
kind: any public hashavatar family, including cat, dog, robot, planet, rocket, frog, panda, cupcake, pizza, octopus, knight, bear, penguin, dragon, ninja, astronaut, diamond, coffee-cup, and shield
background: themed, white, black, dark, light, transparent, polka-dot, striped, checkerboard, grid, sunrise, ocean, or starry
accessory: none, glasses, hat, headphones, crown, bowtie, eyepatch, scarf, halo, or horns
color: default, neon-mint, pastel-pink, crimson, gold, or deep-sea-blue
expression: default, happy, grumpy, surprised, sleepy, winking, cool, or crying
shape: square, circle, squircle, hexagon, or octagon
format: output format; only webp is supported
size: from 64 up to 1024

Accessory an expression layers gëlle fir character-style families. Object-style families wéi planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup a shield ginn op accessory=none an expression=default normaliséiert.

Ënnerschriwwe Späicherlinken

Wann dësen deployment object storage konfiguréiert huet, frot e presigned storage link vun /v1/avatar/link un. Dësen endpoint späichert den generated object a gëtt JSON mat signed URL, object key an hashed cache key zeréck. Standard avatar responses weisen keng signed-link metadata an response headers.

GET https://hashavatar.app/v1/avatar/[email protected]&algorithm=sha512&kind=robot&background=white&accessory=glasses&color=gold&expression=happy&shape=circle&format=webp&size=256

Open Source

De public site source läit am API repository an de reusable avatar renderer gëtt op crates.io publizéiert. Repository · crates.io