Kömek

hashavatar.app-i browser, frontend ýa-da backend arkaly göni ulan. Her avatar URL deterministic, şonuň üçin şol bir identifier we options hemişe şol bir output berýär.

Basic URL

Ýönekeý public image URL gerek bolsa query endpoint ulan.

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

Has arassa embed URLs isleseň path form ulan.

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

HTML Mysal

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

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 we expression layers character-style families üçin ulanylýar. Planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup we shield ýaly object-style families accessory=none we expression=default hökmünde normalize edilýär.

Signed Storage Links

Bu deployment içinde object storage configured bolsa, /v1/avatar/link-den presigned storage link sora. Ol endpoint generated object-i store edýär we signed URL, object key we hashed cache key bilen JSON gaýtarýar. Standard avatar responses response headers içinde signed-link metadata görkezmeýär.

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 içinde, reusable avatar renderer bolsa crates.io-da publish edilen. Repository · crates.io