hashavatar.app
உதவி ஆவணங்கள் விதிமுறைகள் தனியுரிமை Repository Rust crate
API reference

ஆவணங்கள்

இது public API-க்கான product-facing reference. அதே identity, tenant, style version, avatar family, style options, size, WebP output ஆகியவை major version உள்ளே stable ஆக இருக்க intended.

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-க்கு பதிலாக stable internal 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 rendering direct rendering-ஐ விட அதிக செலவானவை.

Timeouts

Avatar generation மற்றும் storage operations server-side timeouts மூலம் bounded; expensive requests origin-ஐ indefinitely பிடிக்க முடியாது.

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.