API Reference

Galmee

Kun product-facing reference public API ti. Identity, tenant, style version, avatar family, style options, size, fi WebP output walfakkaatan major release keessatti stable ta'uu qabu.

Core Endpoints

  • GET /v1/avatar: returns an avatar asset directly
  • GET /v1/avatar/link: stores the generated avatar in configured object storage and returns signed-link metadata
  • GET /avatar/<kind>/<identity>/webp: path-style public avatar URL
  • GET /docs/openapi.json: machine-readable API description

Operational Endpoints

GET /healthz load balancers fi uptime checks'f public dha. GET /metrics loopback-only dha, non-local peers'f 404 deebisa.

Namespace Support

Products yookaan rollout phases gidduutti visual identity spaces addaan baasuuf tenant fi style_version fayyadami.

GET https://hashavatar.app/v1/[email protected]&tenant=acme&style_version=v2&algorithm=sha512&kind=wizard&background=white&accessory=hat&color=deep-sea-blue&expression=cool&shape=squircle&format=webp&size=256

Anonymous IDs

Raw personal data bakka buusuuf internal stable id yookaan one-way application hash ergi.

printf '%s' '[email protected]' | sha256sum | cut -d' ' -f1

Rate Limits

Public service origin-side rate limits hojiirra oolcha; /v1/avatar/link, direct avatar requests persist=true qaban, fi /og.png irratti limits cimaa qaba, sababni isaa object storage writes fi Open Graph image rendering direct rendering caalaa qaalii waan ta'aniif.

Timeouts

Avatar generation fi storage operations server-side timeouts'n bounded dha, kanaaf expensive requests origin daangaa malee qabachuu hin danda'an.

Errors

  • 400: invalid kind, unsupported algorithm yookaan format, size, yookaan missing identity
  • 408: generation yookaan storage timeout
  • 429: rate limit exceeded
  • 500: rendering yookaan storage failure

OpenAPI

Generated clients yookaan tooling'f fayyadami /docs/openapi.json.