hashavatar.app
সহায়তা ডকুমেন্টেশন শর্তাবলি গোপনীয়তা রিপোজিটরি Rust crate
Integration guide

সহায়তা

Browser, frontend অথবা backend থেকে সরাসরি hashavatar.app ব্যবহার করুন। প্রতিটি avatar URL deterministic, তাই একই identifier এবং options সবসময় একই result তৈরি করে।

Basic URL

সাধারণ public image URL চাইলে query endpoint ব্যবহার করুন।

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

পরিষ্কার embed URLs পছন্দ করলে path form ব্যবহার করুন।

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

HTML example

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

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 এবং expression layers character-style families-এ প্রযোজ্য। planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup এবং shield-এর মতো object-style families accessory=none এবং expression=default-এ normalize হয়।

Signed storage links

এই deployment-এ object storage configured থাকলে /v1/avatar/link থেকে presigned storage link অনুরোধ করুন। Endpoint generated object store করে এবং signed URL, object key ও hashed cache key সহ JSON ফেরত দেয়। Standard avatar responses response headers-এ signed-link metadata expose করে না।

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

Public site source API repository-তে আছে এবং reusable avatar renderer crates.io-তে প্রকাশিত। রিপোজিটরি · crates.io