Dokumintaasje

Dit is de product-facing reference foar de public API. Deselde identity, tenant, style version, avatar family, style options, size en WebP output binne bedoeld om stabyl te bliuwen binnen in 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

Operasjonele Endpoints

GET /healthz is public foar load balancers en uptime checks. GET /metrics is loopback-only en jout 404 foar non-local peers.

Namespace Support

Brûk tenant en style_version om visual identity spaces skieden te hâlden tusken produkten of 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

Anonyme ID's

Stjoer in internal stable id of one-way application hash ynstee fan raw personal data.

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

Rate Limits

De public service brûkt origin-side rate limits, mei strangere limits foar /v1/avatar/link, direct avatar requests mei persist=true en /og.png, omdat object storage writes en Open Graph image rendering djoerder binne as direct rendering.

Timeouts

Avatar generation en storage operations binne beheind mei server-side timeouts, sadat djoere requests de origin net ûnbeheind monopolisearje kinne.

Flaters

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

OpenAPI

Foar generated clients of tooling, brûk /docs/openapi.json.