Ìwé ìtọ́nisọ́nà

Èyí ni product-facing reference fún public API. Identity, tenant, style version, avatar family, style options, size, àti WebP output kan náà yẹ kí ó stable jálẹ̀ 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 jẹ public fún load balancers àti uptime checks. GET /metrics jẹ loopback-only, ó sì ń dá 404 padà fún non-local peers.

Namespace Support

Lo tenant àti style_version láti ya visual identity spaces sọ́tọ̀ láàárín products tàbí 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

Fi internal stable id tàbí one-way application hash ránṣẹ́ dípò raw personal data.

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

Rate Limits

Public service ń fi origin-side rate limits sílẹ̀, pẹ̀lú limits tó lágbára fún /v1/avatar/link, direct avatar requests pẹ̀lú persist=true, àti /og.png nítorí object storage writes àti Open Graph image rendering gbowolori ju direct rendering lọ.

Timeouts

Avatar generation àti storage operations wà labẹ server-side timeouts kí expensive requests má bàa gba origin mọ́lẹ̀ láìní opin.

Errors

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

OpenAPI

Fún generated clients tàbí tooling, lo /docs/openapi.json.