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 लाई अनिश्चित समय कब्जा गर्न सक्दैनन्।

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.