Dokumentazioa

Hau public API-ren product-facing reference da. Identity, tenant, style version, avatar family, style options, size eta WebP output berdinak major release osoan stable izatea espero da.

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 da load balancers eta uptime checks-entzat. GET /metrics loopback-only da eta non-local peers-entzat 404 itzultzen du.

Namespace Support

Erabili tenant eta style_version products edo rollout phases arteko visual identity spaces bereizteko.

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

Bidali internal stable id edo one-way application hash raw personal data bidali ordez.

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

Rate Limits

Public service-k origin-side rate limits aplikatzen ditu, /v1/avatar/link, persist=true duten direct avatar requests eta /og.png-rako limits zorrotzagoekin, object storage writes eta Open Graph image rendering direct rendering baino garestiagoak direlako.

Timeouts

Avatar generation eta storage operations server-side timeouts bidez bounded daude, expensive requests-ek origin mugagabe atxiki ez dezaten.

Errors

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

OpenAPI

Generated clients edo tooling-erako, erabili /docs/openapi.json.