Sənədlər

Bu public API üçün product-facing reference-dir. Eyni identity, tenant, style version, avatar family, style options, size və WebP output major release boyunca stable qalmalıdır.

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 və uptime checks üçün public-dir. GET /metrics loopback-only-dir və non-local peers üçün 404 qaytarır.

Namespace Support

Products və ya rollout phases arasında visual identity spaces ayırmaq üçün tenant və style_version istifadə et.

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 yerinə internal stable id və ya one-way application hash göndər.

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

Rate Limits

Public service origin-side rate limits tətbiq edir; /v1/avatar/link, persist=true olan direct avatar requests və /og.png üçün daha sərt limits var, çünki object storage writes və Open Graph image rendering direct rendering-dən daha bahalıdır.

Timeouts

Avatar generation və storage operations server-side timeouts ilə bounded-dir ki, expensive requests origin-i limitsiz tutmasın.

Errors

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

OpenAPI

Generated clients və ya tooling üçün istifadə et /docs/openapi.json.