Resminamalar

Bu public API üçin product-facing reference. Şol bir identity, tenant, style version, avatar family, style options, size we WebP output major release dowamynda stable galmaly.

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 load balancers we uptime checks üçin public. GET /metrics loopback-only we non-local peers üçin 404 gaýtarýar.

Namespace Support

Products ýa-da rollout phases arasynda visual identity spaces bölmek üçin tenant we style_version ulan.

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

Raw personal data ýerine internal stable id ýa-da one-way application hash iber.

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

Rate Limits

Public service origin-side rate limits ulanýar; /v1/avatar/link, persist=true bolan direct avatar requests we /og.png üçin limits has berk, sebäbi object storage writes we Open Graph image rendering direct rendering-den gymmat.

Timeouts

Avatar generation we storage operations server-side timeouts bilen bounded, şonuň üçin expensive requests origin-i çäksiz saklap bilmeýär.

Errors

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

OpenAPI

Generated clients ýa-da tooling üçin ulan /docs/openapi.json.