API Reference

Dokumentašuvdna

Dát lea product-facing reference public API várás. Seamma identity, tenant, style version, avatar family, style options, size ja WebP output galget leat stabila major release siste.

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

Doaibma Endpoints

GET /healthz lea public load balancers ja uptime checks várás. GET /metrics lea loopback-only ja máhcaha 404 non-local peers várás.

Namespace Doarjja

Geavat tenant ja style_version vai visual identity spaces leat sierra buktagiid dahje rollout phases gaskkas.

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

Anonyma ID:at

Sádde internal stable id dahje one-way application hash raw personal data sajis.

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

Rate Limits

Public service geavaha origin-side rate limits, garraset rájiiguin /v1/avatar/link, direct avatar requests persist=true ja /og.png várás, danne go object storage writes ja Open Graph image rendering leat divraset go direct rendering.

Timeouts

Avatar generation ja storage operations leat ráddjejuvvon server-side timeouts bokte, vai divrras requests eai sáhte váldit origin agálaččat.

Meattáhusat

  • 400: gustohis kind, unsupported algorithm dahje format, size dahje missing identity
  • 408: generation dahje storage timeout
  • 429: rate limit exceeded
  • 500: rendering dahje storage failure

OpenAPI

Generated clients dahje tooling várás, geavat /docs/openapi.json.