Atmee.aiDocs
APIAPI referenceAvatars

Update sponsor settings

PATCH
/v1/avatars/{avatarId}/sponsor

One request applies all of its fields or none. anonymousAccess: true lets visitors without an account spend the pool, so it needs an avatar that was funded (409 avatar_not_budget_managed: grant credits first, or turn on auto top-up) and is public or unlisted (409 avatar_not_shared: change its visibility first). A monetized avatar cannot be sponsored (409 monetized_avatar_cannot_be_sponsored). autoTopupEnabled: true needs a threshold and an amount, sent here or already stored (400 auto_topup_incomplete).

Authorization

headerX-Api-Key<token>

Secret embed API key (sk_atmee_...; keys minted before 2026-09 carry sk_live_...), held by the customer's own backend and never sent to a browser. Format: X-Api-Key: sk_atmee_....

Path Parameters

avatarId*string
Formatuuid

Request Body

application/json
  1. body
Properties1 <= properties
maxPerSessionMicrocredits?integer

null clears the cap.

Range1 <= value
exhaustedBehavior?string
Value in"pause""spend_balance"
autoTopupEnabled?boolean
autoTopupThresholdMicrocredits?integer
Range1 <= value
autoTopupAmountMicrocredits?integer
Range1 <= value
anonymousAccess?boolean
anonymousDailySecondsPerVisitor?integer

null clears the per-visitor daily cap.

Range1 <= value

Response Body

Updated; returns the sponsor view.

application/json
  1. response
balance*
settings*
Example Request
curl -X PATCH 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/sponsor' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "balance": {    "totalMicrocredits": 0,    "planSourcedMicrocredits": 0,    "topupSourcedMicrocredits": 0,    "couponSourcedMicrocredits": 0  },  "settings": {    "maxPerSessionMicrocredits": 0,    "exhaustedBehavior": "pause",    "autoTopupEnabled": true,    "autoTopupThresholdMicrocredits": 0,    "autoTopupAmountMicrocredits": 0,    "anonymousAccess": true,    "anonymousDailySecondsPerVisitor": 0  }}

Sponsor pool balance and settings GET

Callable by an API key (avatars:read) or a signed-in user acting for the account.

Move credits from the account into the avatar's sponsor pool POST

Send an Idempotency-Key header to make retries safe: the same key replays the first successful result instead of granting twice.

Update sponsor settings — Atmee Docs