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

Це product-facing reference для public API. Однакові identity, tenant, style version, avatar family, style options, size і WebP output мають залишатися стабільними в межах major version.

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 і uptime checks. GET /metrics доступний лише через loopback і повертає 404 для non-local peers.

Підтримка namespace

Використовуйте tenant і style_version, щоб розділяти візуальні identity spaces між продуктами або 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

Надсилайте стабільний internal id або one-way application hash замість сирих персональних даних.

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 rendering дорожчі за direct rendering.

Timeouts

Avatar generation і storage operations обмежені server-side timeouts, щоб expensive requests не могли нескінченно займати origin.

Помилки

400: некоректний kind, непідтримуваний algorithm або format, size або відсутній identity
408: generation або storage timeout
429: rate limit перевищено
500: rendering або storage failure

OpenAPI

Для generated clients або tooling використовуйте /docs/openapi.json.