Atmee.aiDocs
APIAPI referenceAvatars

Sponsor pool balance and settings

GET
/v1/avatars/{avatarId}/sponsor

Callable by an API key (avatars:read) or a signed-in user acting for the account. Sponsoring otherwise takes an API key with billing:write or a signed-in user, who sponsors the account's avatars as in Studio without holding that scope.

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

Response Body

Balance and settings.

application/json
  1. response
balance*
settings*
Example Request
curl -X GET 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/sponsor'
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  }}

Set the graph conductor of a v2 avatar PUT

Gives the avatar's conversations an agenda: a graph of steps, each with the avatar's instructions while the conversation is in it, and edges that say when it moves on.

Update sponsor settings PATCH

One request applies all of its fields or none.

Sponsor pool balance and settings — Atmee Docs