Caawimo

Ka isticmaal hashavatar.app browser, frontend, ama backend si toos ah. Avatar URL kasta waa deterministic, sidaas darteed identifier iyo options isku mid ah mar kasta waxay bixiyaan output isku mid ah.

Basic URL

Isticmaal query endpoint marka aad u baahan tahay public image URL fudud.

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

Isticmaal path form haddii aad rabto embed URLs nadiif ah.

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

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

Tusaale 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 iyo expression layers waxay shaqeeyaan character-style families. Object-style families sida planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, iyo shield waxaa loo normalize gareeyaa accessory=none iyo expression=default.

Signed Storage Links

Haddii deployment-kan uu leeyahay object storage configured, ka codso presigned storage link /v1/avatar/link. Endpoint-kaas wuxuu store gareeyaa generated object wuxuuna soo celiyaa JSON leh signed URL, object key, iyo hashed cache key. Standard avatar responses ma muujinayaan signed-link metadata gudaha 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-ka public site wuxuu ku jiraa API repository, reusable avatar renderer-na waxaa lagu publish gareeyay crates.io. Repository · crates.io