Akwụkwọ

Nke a bụ product-facing reference maka public API. Identity, tenant, style version, avatar family, style options, size, na WebP output otu kwesịrị ịnọ stable n'ime 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 bụ public maka load balancers na uptime checks. GET /metrics bụ loopback-only ma na-eweghachi 404 maka non-local peers.

Namespace Support

Jiri tenant na style_version kewaa visual identity spaces n'etiti products ma ọ bụ 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

Anonymous IDs

Zipu internal stable id ma ọ bụ one-way application hash kama raw personal data.

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

Rate Limits

Public service na-etinye origin-side rate limits, nwere limits siri ike maka /v1/avatar/link, direct avatar requests nwere persist=true, na /og.png n'ihi na object storage writes na Open Graph image rendering dị ọnụ karịa direct rendering.

Timeouts

Avatar generation na storage operations bounded site na server-side timeouts ka expensive requests ghara ijide origin ruo mgbe ebighị ebi.

Errors

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

OpenAPI

Maka generated clients ma ọ bụ tooling, jiri /docs/openapi.json.