Atmee.aiDocs
APIAPI referenceAccount

The account's plan, limits, prices and capture quota

GET
/v1/account

The plan the account is on (and the one it changes to at the end of the cycle, if any), the limits that apply to its API usage, what a session minute, a preview clip and (where generation is offered, pricing.generation) one generation call cost, and how many v2 captures are queued or running against the pending cap. Prices are in microcredits (100 microcredits = 1 credit). A conversation (POST /v1/sessions) is charged sessionPerMinuteMicrocredits with a v1 avatar and sessionV2PerMinuteMicrocredits with a v2 one; an avatar session (render only) the avatar engine's render rate (renderV1PerMinuteMicrocredits or renderV2PerMinuteMicrocredits). A limit, or a plan field, that is absent is not set (a limit absent is not capped by the plan). payouts says whether the account can be paid out, which monetizing an avatar needs.

Readable by the same callers as GET /v1/account/balance.

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_....

Response Body

The account.

application/json
  1. response
accountId*string
plan*
limits*
pricing*
captureQuota*

v2 captures queued or running, against the pending cap (as X-RateLimit-* on a v2 create).

payouts?

Whether the account can be paid out (its Stripe Connect payout account), as last synced from Stripe. Monetizing an avatar needs verified; payouts are set up in Creator Studio. Absent when the database does not report it.

links?

The account's pages on the Atmee website, ready to hand to a person. Absent when this deployment does not know the website's address.

v2Access?string

Whether this account may build v2 avatars (engine: v2). granted: it may. invite_required: v2 is invite-only for now and this account has not been let in; v2 creates, candidates, versions, the conductor and v2 rebuilds answer 403 v2_access_required until it redeems an invite code in Creator Studio (links.billing). Use engine: v1 meanwhile. unavailable: v2 is not offered on this server. Absent when it could not be determined.

Value in"granted""invite_required""unavailable"
Example Request
curl -X GET 'https://api.atmanity.us/v1/account'
Example Response
{  "accountId": "string",  "plan": {    "code": "string",    "name": "string",    "includedMicrocredits": 0,    "cycleEnd": "2019-08-24T14:15:22Z",    "pendingPlan": {      "code": "string",      "name": "string"    }  },  "limits": {    "apiAccess": true,    "maxSessionSeconds": 0,    "maxConcurrentSessions": 0,    "maxApiAvatars": 0  },  "pricing": {    "sessionPerMinuteMicrocredits": 0,    "sessionV2PerMinuteMicrocredits": 0,    "monetizedPerMinuteMicrocredits": 0,    "monetizedV2PerMinuteMicrocredits": 0,    "renderV1PerMinuteMicrocredits": 0,    "renderV2PerMinuteMicrocredits": 0,    "previewClipMicrocredits": 0,    "speechPerMinuteMicrocredits": 0,    "generation": {      "portraitsMicrocredits": 0,      "enhancementsMicrocredits": 0,      "voicesMicrocredits": 0,      "clipPer15SecondsMicrocredits": 0,      "clipPerSecondMicrocredits": 0,      "clipResolutions": [        {          "width": 256,          "height": 256        }      ]    }  },  "captureQuota": {    "pending": 0,    "pendingLimit": 0  },  "payouts": {    "status": "not_started",    "verifiedAt": "2019-08-24T14:15:22Z"  },  "links": {    "explore": "http://example.com",    "avatars": "http://example.com",    "create": "http://example.com",    "billing": "http://example.com",    "apiKeys": "http://example.com",    "analytics": "http://example.com",    "docs": "http://example.com"  },  "v2Access": "granted"}
The account's plan, limits, prices and capture quota — Atmee Docs