Dokumentatioun

Dëst ass d'product-facing reference fir d'public API. Déiselwecht identity, tenant, style version, avatar family, style options, size a WebP output solle bannent engem major release stabil bleiwen.

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 ass public fir load balancers an uptime checks. GET /metrics ass loopback-only a gëtt 404 fir non-local peers zeréck.

Namespace Support

Benotzt tenant a style_version fir visual identity spaces tëscht Produkter oder rollout phases getrennt ze halen.

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

Anonym IDen

Schéckt eng internal stable id oder one-way application hash amplaz vu raw personal data.

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

Rate Limits

De public service applizéiert origin-side rate limits, mat méi strenge limits fir /v1/avatar/link, direct avatar requests mat persist=true an /og.png, well object storage writes an Open Graph image rendering méi deier sinn ewéi direct rendering.

Timeouts

Avatar generation an storage operations si mat server-side timeouts limitéiert, sou datt deier Ufroen den origin net onendlech monopoliséiere kënnen.

Feeler

400: ongültege kind, unsupported algorithm oder format, size oder missing identity
408: generation oder storage timeout
429: rate limit exceeded
500: rendering oder storage failure

OpenAPI

Fir generated clients oder tooling, benotzt /docs/openapi.json.