Документация

Това е product-facing reference за public API. Същите identity, tenant, style version, avatar family, style options, size и WebP output са предназначени да останат стабилни в рамките на 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

Операционни Endpoints

GET /healthz е публичен за load balancers и uptime checks. GET /metrics е loopback-only и връща 404 за non-local peers.

Namespace Поддръжка

Използвайте tenant и style_version, за да държите визуалните identity spaces отделни между продукти или rollout фази.

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

Изпращайте internal stable id или one-way application hash вместо raw personal data.

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

Rate Limits

Public service прилага origin-side rate limits, с по-строги limits за /v1/avatar/link, direct avatar requests с persist=true и /og.png, защото object storage writes и Open Graph image rendering са по-скъпи от direct rendering.

Timeouts

Avatar generation и storage operations са ограничени със server-side timeouts, така че скъпите заявки да не монополизират origin безкрайно.

Грешки

400: невалиден kind, unsupported algorithm или format, size или missing identity
408: generation или storage timeout
429: rate limit exceeded
500: rendering или storage failure

OpenAPI

За generated clients или tooling използвайте /docs/openapi.json.