Takardu

Wannan product-facing reference ne don public API. Ana sa ran identity, tenant, style version, avatar family, style options, size, da WebP output iri ɗaya su kasance stable a cikin 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 ne don load balancers da uptime checks. GET /metrics loopback-only ne kuma yana dawo da 404 ga non-local peers.

Namespace Support

Yi amfani da tenant da style_version don raba visual identity spaces tsakanin products ko 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

Aika internal stable id ko one-way application hash maimakon raw personal data.

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

Rate Limits

Public service yana aiwatar da origin-side rate limits, tare da limits masu tsauri ga /v1/avatar/link, direct avatar requests masu persist=true, da /og.png saboda object storage writes da Open Graph image rendering sun fi direct rendering tsada.

Timeouts

Avatar generation da storage operations suna bounded da server-side timeouts domin expensive requests ba za su riƙe origin ba har abada.

Errors

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

OpenAPI

Don generated clients ko tooling, yi amfani da /docs/openapi.json.