hashavatar.app
సహాయం డాక్యుమెంటేషన్ నిబంధనలు గోప్యత Repository Rust Crate
API Reference

డాక్యుమెంటేషన్

ఇది public API కోసం product-facing reference. ఒకే identity, tenant, style version, avatar family, style options, size, WebP output major release లో stable గా ఉండాలి.

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 మరియు uptime checks కోసం public. GET /metrics loopback-only మరియు non-local peers కు 404 ఇస్తుంది.

Namespace Support

Products లేదా rollout phases మధ్య visual identity spaces వేరు చేయడానికి tenant మరియు style_version ఉపయోగించండి.

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 బదులుగా internal stable id లేదా one-way application hash పంపండి.

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

Rate Limits

Public service origin-side rate limits అమలు చేస్తుంది. /v1/avatar/link, persist=true ఉన్న direct avatar requests, మరియు /og.png కు కఠినమైన limits ఉంటాయి, ఎందుకంటే object storage writes మరియు Open Graph image rendering direct rendering కంటే ఖరీదైనవి.

Timeouts

Avatar generation మరియు storage operations server-side timeouts తో bounded, కాబట్టి expensive requests origin ను unlimited గా ఆక్రమించలేవు.

Errors

  • 400: invalid kind, unsupported algorithm లేదా format, size, లేదా missing identity
  • 408: generation లేదా storage timeout
  • 429: rate limit exceeded
  • 500: rendering లేదా storage failure

OpenAPI

Generated clients లేదా tooling కోసం ఉపయోగించండి /docs/openapi.json.