Dokumentasie

Dit is die product-facing reference vir die public API. Dieselfde identity, tenant, style version, avatar family, style options, size, en WebP output behoort stabiel te bly deur 'n 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 is public vir load balancers en uptime checks. GET /metrics is loopback-only en gee 404 terug vir non-local peers.

Namespace Support

Gebruik tenant en style_version om visual identity spaces tussen products of rollout phases te skei.

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

Stuur 'n internal stable id of one-way application hash eerder as raw personal data.

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

Rate Limits

Die public service pas origin-side rate limits toe, met strenger limits vir /v1/avatar/link, direct avatar requests met persist=true, en /og.png omdat object storage writes en Open Graph image rendering duurder is as direct rendering.

Timeouts

Avatar generation en storage operations is bounded deur server-side timeouts sodat expensive requests nie die origin onbeperk kan vashou nie.

Errors

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

OpenAPI

Vir generated clients of tooling, gebruik /docs/openapi.json.