Taimako

Yi amfani da hashavatar.app kai tsaye daga browser, frontend, ko backend. Kowane avatar URL deterministic ne, don haka identifier da options iri ɗaya koyaushe suna bada output iri ɗaya.

Basic URL

Yi amfani da query endpoint idan kana buƙatar public image URL mai sauƙi.

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

Yi amfani da path form idan kana son embed URLs masu tsabta.

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

Misalin HTML

<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"
/>

Misalin JavaScript

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 da expression layers suna aiki ga character-style families. Object-style families kamar planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, da shield ana normalize su zuwa accessory=none da expression=default.

Signed Storage Links

Idan wannan deployment yana da object storage configured, nemi presigned storage link daga /v1/avatar/link. Endpoint ɗin yana store generated object kuma yana dawo da JSON mai signed URL, object key, da hashed cache key. Standard avatar responses ba sa nuna signed-link metadata a 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 na public site yana cikin API repository, kuma reusable avatar renderer an publish shi a crates.io. Repository · crates.io