Dokumentasyon

Ito ang product-facing reference para sa public API. Inaasahang stable sa loob ng major release ang parehong identity, tenant, style version, avatar family, style options, size, at WebP output.

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

Public ang GET /healthz para sa load balancers at uptime checks. Loopback-only ang GET /metrics at nagbabalik ng 404 sa non-local peers.

Namespace Support

Gamitin ang tenant at style_version para paghiwalayin ang visual identity spaces sa pagitan ng 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

Magpadala ng internal stable id o one-way application hash sa halip na raw personal data.

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

Rate Limits

Nagpapatupad ang public service ng origin-side rate limits, na may mas mahigpit na limit para sa /v1/avatar/link, direct avatar requests na may persist=true, at /og.png dahil mas mahal ang object storage writes at Open Graph image rendering kaysa direct rendering.

Timeouts

Ang avatar generation at storage operations ay bounded ng server-side timeouts para hindi makontrol ng mahal na request ang origin nang walang hanggan.

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

Para sa generated clients o tooling, gamitin /docs/openapi.json.