Atmee.aiDocs
APIAPI referenceAvatars

The avatar's monetization eligibility and earnings

GET
/v1/avatars/{avatarId}/monetization

What Creator Studio's monetization panel shows: whether the avatar is monetized, its last 30 days against the eligibility requirements, the account's cap on monetizing avatars, and what it has earned. The 30-day numbers leave out the account's own conversations. Earnings are in microcredits (100 = 1 credit); the current cycle is the account's billing cycle. Requires avatars:read; an avatar-scoped key reads only its own avatar.

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

The avatar's monetization eligibility and earnings.

application/json
  1. response

An avatar's monetization, as Creator Studio's monetization panel shows it (read only here).

monetized*boolean

Whether monetization is on for the avatar.

eligible*boolean

Whether the last 30 days meet every requirement.

last30Days*

Completed conversations of the last 30 days, the account's own left out.

requirements*

The 30-day thresholds of eligibility, and which the avatar meets.

accountCap*

The account's limit on monetizing avatars.

earnings*

What the avatar has earned, in microcredits (100 = 1 credit); the current cycle is the account's billing cycle.

Example Request
curl -X GET 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/monetization'
Example Response
{  "monetized": true,  "eligible": true,  "last30Days": {    "conversations": 0,    "minutes": 0.1,    "uniqueUsers": 0  },  "requirements": {    "conversations": 0,    "minutes": 0,    "uniqueUsers": 0,    "meetsConversations": true,    "meetsMinutes": true,    "meetsUniqueUsers": true  },  "accountCap": {    "monetizingAvatars": 0,    "cap": 0,    "atCap": true  },  "earnings": {    "allTimeMicrocredits": 0,    "currentCycleMicrocredits": 0,    "allTimeSessions": 0,    "currentCycleSessions": 0  }}

Replace the avatar's knowledge files PUT

Replaces the whole knowledge set: repeat the files part for each document (pdf, docx, doc, txt, md, html, csv <= 50 MB each; up to 20 files).

Remove the avatar's Explore thumbnail DELETE

Removes the thumbnail, custom or automatic: Explore shows the portrait in its place, and an automatic thumbnail may be made for the avatar again.

The avatar's monetization eligibility and earnings — Atmee Docs