Integration Guide

मदत

hashavatar.app थेट browser, frontend किंवा backend मधून वापरा. प्रत्येक 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 वर publish केलेला आहे. Repository · crates.io