Atmee.aiDocs
APIAPI referenceAvatars

Return unreserved sponsor credits to the account

POST
/v1/avatars/{avatarId}/sponsor/withdrawals

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
microcredits?integer

Omit to withdraw everything that is not reserved by a running session.

Range1 <= value

Response Body

Withdrawn.

application/json
  1. response
withdrawnMicrocredits*integer
Example Request
curl -X POST 'https://api.atmanity.us/v1/avatars/497f6eca-6276-4993-bfeb-53cbbbba6f08/sponsor/withdrawals' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "withdrawnMicrocredits": 0}

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.

Generate portraits from a description POST

Generates up to four square portraits from a text description, one from each configured image provider, with Atmee Studio's portrait prompt.