Documentación

Esta é a product-facing reference da public API. O mesmo identity, tenant, style version, avatar family, style options, size e WebP output deberían permanecer stable durante unha 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 é public para load balancers e uptime checks. GET /metrics é loopback-only e devolve 404 para non-local peers.

Namespace Support

Usa tenant e style_version para separar visual identity spaces entre products ou 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

Envía un internal stable id ou one-way application hash no canto de raw personal data.

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

Rate Limits

O public service aplica origin-side rate limits, con limits máis estritos para /v1/avatar/link, direct avatar requests con persist=true e /og.png porque object storage writes e Open Graph image rendering son máis custosos ca direct rendering.

Timeouts

Avatar generation e storage operations están bounded por server-side timeouts para que expensive requests non poidan reter o origin sen límite.

Errors

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

OpenAPI

Para generated clients ou tooling, usa /docs/openapi.json.