Help

Brûk hashavatar.app direkt út de browser, dyn frontend of dyn backend. Elke avatar URL is deterministysk, dus deselde identifikator en opsjes jouwe altyd itselde resultaat.

Basis URL

Brûk de query endpoint ast in ienfâldige publike image URL wolst.

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

Brûk de path foarm ast skjinnere embed URLs leaver hast.

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

HTML Foarbyld

<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 Foarbyld

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();

Stipe Parameters

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 en expression layers jilde foar character-style families. Object-style families lykas planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup en shield wurde normalisearre nei accessory=none en expression=default.

Undertekene Opslachkeppelings

As dizze deployment object storage konfigurearre hat, freegje dan in presigned storage link oan fan /v1/avatar/link. Dy endpoint bewarret it generated object en jout JSON werom mei signed URL, object key en hashed cache key. Standert avatar responses litte gjin signed-link metadata sjen yn 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 source fan de publike site stiet yn it API repository en de reusable avatar renderer wurdt publisearre op crates.io. Repository · crates.io