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

tenant اور style_version استعمال کریں تاکہ products یا rollout phases کے درمیان visual identity spaces separate رہیں۔

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 apply کرتی ہے، /v1/avatar/link، persist=true والے direct avatar requests، اور /og.png پر stricter limits کے ساتھ کیونکہ object storage writes اور Open Graph image rendering direct rendering سے زیادہ expensive ہیں۔

Timeouts

Avatar generation اور storage operations server-side timeouts سے bounded ہیں تاکہ expensive requests origin کو indefinitely monopolize نہ کر سکیں۔

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.