hashavatar.app
Ajuda Documentació Condicions Privadesa Repository Rust Crate
API Reference

Documentació

Aquesta és la product-facing reference per a la public API. El mateix identity, tenant, style version, avatar family, style options, size i WebP output haurien de mantenir-se stable durant una major release.

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 és public per a load balancers i uptime checks. GET /metrics és loopback-only i retorna 404 per a non-local peers.

Namespace Support

Utilitza tenant i style_version per separar visual identity spaces entre products o rollout phases.

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

Envia un internal stable id o one-way application hash en lloc de raw personal data.

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

Rate Limits

El public service aplica origin-side rate limits, amb limits més estrictes per a /v1/avatar/link, direct avatar requests amb persist=true i /og.png perquè object storage writes i Open Graph image rendering són més costosos que direct rendering.

Timeouts

Avatar generation i storage operations estan bounded per server-side timeouts perquè expensive requests no puguin retenir l'origin sense límit.

Errors

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

OpenAPI

Per a generated clients o tooling, utilitza /docs/openapi.json.