hashavatar.app
मद्दत दस्तावेज सर्तहरू गोपनीयता Repository Rust Crate
Integration Guide

मद्दत

hashavatar.app लाई browser, frontend, वा backend बाट सीधै प्रयोग गर्नुहोस्। हरेक avatar URL deterministic हुन्छ, त्यसैले एउटै identifier र options ले सधैं एउटै output दिन्छ।

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 उदाहरण

<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 उदाहरण

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 देखाउँदैन।

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 मा publish गरिएको छ। Repository · crates.io