Ìrànlọ́wọ́

Lo hashavatar.app taara láti browser, frontend, tàbí backend rẹ. Avatar URL kọọkan jẹ deterministic, nítorí náà identifier àti options kan náà máa ń fúnni ní output kan náà.

Basic URL

Lo query endpoint nígbà tí o bá nílò public image URL tó rọrùn.

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

Lo path form bí o bá fẹ́ embed URLs tó mọ́ síi.

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

HTML Àpẹẹrẹ

<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 Àpẹẹrẹ

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

Supported 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 àti expression layers ń ṣiṣẹ́ fún character-style families. Object-style families bí planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, àti shield ni a normalize sí accessory=none àti expression=default.

Signed Storage Links

Bí deployment yìí bá ní object storage configured, béèrè presigned storage link láti /v1/avatar/link. Endpoint náà ń store generated object, ó sì ń dá JSON padà pẹ̀lú signed URL, object key, àti hashed cache key. Standard avatar responses kì í fi signed-link metadata hàn nínú 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

Source ti public site wà nínú API repository, reusable avatar renderer sì wà ní crates.io. Repository · crates.io