Ducumentazzioni

Chista è la product-facing reference pi la public API. Stissa identity, tenant, style version, avatar family, style options, size e WebP output sunnu pinsati pi ristari stabbili intra na 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

Endpoint Operativi

GET /healthz è public pi load balancers e uptime checks. GET /metrics è loopback-only e torna 404 pi non-local peers.

Supportu Namespace

Usa tenant e style_version pi tèniri visual identity spaces siparati tra prudutti 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

ID Anònimi

Manna internal stable id o one-way application hash mmeci di raw personal data.

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

Rate Limits

La public service applica origin-side rate limits, cu limiti cchiù stritti pi /v1/avatar/link, direct avatar requests cu persist=true e /og.png, pirchì object storage writes e Open Graph image rendering sunnu cchiù custusi di direct rendering.

Timeouts

Avatar generation e storage operations sunnu limitati di server-side timeouts, accussì richiesti custusi nun ponnu monopolizzari l'origin senza fini.

Errura

400: kind non vàlidu, unsupported algorithm o format, size o missing identity
408: generation o storage timeout
429: rate limit exceeded
500: rendering o storage failure

OpenAPI

Pi generated clients o tooling, usa /docs/openapi.json.