Amadokhumenti

Lokhu kuyi-product-facing reference ye-public API. Identity, tenant, style version, avatar family, style options, size, ne-WebP output okufanayo kulindeleke kuhlale stable phakathi kwe-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 public kuma-load balancers nama-uptime checks. GET /metrics loopback-only futhi ibuyisa 404 kuma-non-local peers.

Namespace Support

Sebenzisa tenant ne-style_version ukuhlukanisa visual identity spaces phakathi kwama-products noma 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

Thumela internal stable id noma one-way application hash esikhundleni se-raw personal data.

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

Rate Limits

Public service isebenzisa origin-side rate limits, nge-limits eziqinile ze-/v1/avatar/link, direct avatar requests ezine-persist=true, ne-/og.png ngoba object storage writes ne-Open Graph image rendering zibiza kakhulu kune-direct rendering.

Timeouts

Avatar generation nama-storage operations abounded nge-server-side timeouts ukuze expensive requests zingakwazi ukubamba origin ngaphandle komkhawulo.

Errors

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

OpenAPI

Ukuze usebenzise generated clients noma tooling, sebenzisa /docs/openapi.json.