Dokumentasi

Iki product-facing reference kanggo public API. Identity, tenant, style version, avatar family, style options, size, lan WebP output sing padha dikarepake tetep stabil sajrone 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 kanggo load balancers lan uptime checks. GET /metrics loopback-only lan mbalekake 404 kanggo non-local peers.

Dhukungan Namespace

Gunakake tenant lan style_version kanggo misahake visual identity spaces antar produk utawa 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 Anonim

Kirim internal stable id utawa one-way application hash tinimbang raw personal data.

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

Rate Limits

Public service ngetrapake origin-side rate limits, kanthi limit luwih ketat kanggo /v1/avatar/link, direct avatar requests nganggo persist=true, lan /og.png amarga object storage writes lan Open Graph image rendering luwih larang tinimbang direct rendering.

Timeouts

Avatar generation lan storage operations diwatesi server-side timeouts supaya request larang ora bisa nguwasani origin tanpa wates.

Errors

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

OpenAPI

Kanggo generated clients utawa tooling, gunakake /docs/openapi.json.