Dukumenti

Tani waa product-facing reference ee public API. Identity, tenant, style version, avatar family, style options, size, iyo WebP output isku mid ah waxaa laga filayaa inay stable ahaadaan inta major release socdo.

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 waa public loogu talagalay load balancers iyo uptime checks. GET /metrics waa loopback-only wuxuuna non-local peers u celiyaa 404.

Namespace Support

Isticmaal tenant iyo style_version si aad u kala saarto visual identity spaces u dhexeeya products ama 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

Dir internal stable id ama one-way application hash halkii aad ka diri lahayd raw personal data.

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

Rate Limits

Public service wuxuu dhaqan geliyaa origin-side rate limits, limits adag oo loogu talagalay /v1/avatar/link, direct avatar requests leh persist=true, iyo /og.png sababtoo ah object storage writes iyo Open Graph image rendering way ka qaalisan yihiin direct rendering.

Timeouts

Avatar generation iyo storage operations waxaa lagu xadiday server-side timeouts si expensive requests aysan origin u qabsan si aan xad lahayn.

Errors

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

OpenAPI

Generated clients ama tooling u isticmaal /docs/openapi.json.