Nyaraka

Hii ni product-facing reference ya public API. Identity, tenant, style version, avatar family, style options, size, na WebP output vinatarajiwa kubaki stable ndani ya 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 ni public kwa load balancers na uptime checks. GET /metrics ni loopback-only na hurudisha 404 kwa non-local peers.

Msaada Wa Namespace

Tumia tenant na style_version kutenganisha visual identity spaces kati ya products au 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 Zisizo Na Majina

Tuma internal stable id au one-way application hash badala ya raw personal data.

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

Rate Limits

Public service hutekeleza origin-side rate limits, na limit kali zaidi kwa /v1/avatar/link, direct avatar requests zenye persist=true, na /og.png kwa sababu object storage writes na Open Graph image rendering ni ghali zaidi kuliko direct rendering.

Timeouts

Avatar generation na storage operations zinawekewa server-side timeouts ili request ghali zisichukue origin bila kikomo.

Errors

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

OpenAPI

Kwa generated clients au tooling, tumia /docs/openapi.json.