Hosted Avatar API

The hosted API exposes one active image endpoint per paid account:

GET /api/v1/avatars/ENDPOINT_ID

It is designed for direct browser embedding, not Bearer-token API calls. The endpoint ID is provisioned after the first verified successful payment and appears in the dashboard.

<img
  src="https://YOUR_BLOBZ_HOST/api/v1/avatars/ENDPOINT_ID?name=Janaki&amp;frame=rounded&amp;palette=%23f2f1f4%2C%237c6cf2&amp;size=80"
  crossorigin="anonymous"
  width="80"
  height="80"
  alt="Janaki avatar"
/>

Contract at a glanceCopy Anchor Link

• name is required; frame, palette, and size are optional.
• The same inputs use the same renderer and defaults as @blobz/react.
• Cross-origin browsers must send an Origin matching one of the account's approved origins. The Blobz deployment serving the docs is trusted for its same-origin playground.
• An account can approve five exact origins total.
• Successful responses count toward the account's monthly allowance.
• Rejected requests do not consume the monthly allowance.
• Every response is uncached with Cache-Control: no-store, so every network request reaches quota enforcement.

Continue with the quickstart, then review origin security and limits and errors. The generated endpoint reference is sourced from the checked-in OpenAPI schema.