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