Integration Guide

Gargaarsa

hashavatar.app browser, frontend, yookaan backend kee irraa kallattiin fayyadami. Avatar URL hundi deterministic dha, kanaaf identifier fi options walfakkaatan yeroo hunda output walfakkaataa kennu.

Basic URL

public image URL salphaa barbaaddu yeroo query endpoint fayyadami.

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 qulqulluu yoo barbaadde path form fayyadami.

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

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

Fakkeenya 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 fi expression layers character-style families irratti hojjatu. Object-style families akka planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, fi shield gara accessory=none fi expression=default normalize ta'u.

Signed Storage Links

Deployment kun object storage configured yoo qabaate, /v1/avatar/link irraa presigned storage link gaafadhu. Endpoint sun generated object store godha, JSON signed URL, object key, fi hashed cache key qabu deebisa. Standard avatar responses response headers keessatti signed-link metadata hin mul'isan.

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 public site API repository keessa jira, reusable avatar renderer immoo crates.io irratti publish ta'eera. Repository · crates.io