Get your account
Your balance, this key’s settings, and the limits in force.
GET/v2/accountcredits.spendable is your balance: what your API wallet can spend now. Your Studio plan and balance are separate and do not count here. Check it before a large batch so a run does not stop halfway with 402.
limits.daily_credits is what this key may spend per UTC day, the tighter of your tier’s limit and the one you set on the key; null means no limit. limits.scope says what the limits are counted against: account on the free tier, where every key shares them, and key once you have topped up your API wallet.
Amounts in API credits
Every amount is in US dollars, to four decimals: balance_usd and the daily limits here, charged_usd and refunded_usd on a job, the _usd prices from GET /v2/engines, and the balance_usd and threshold_usd of the credits.low webhook. So a v4.6 render, $0.2475, is 0.2475 in those fields. Each also has an older field counting the same amount in API credits, a unit worth $0.0099 (credits_charged, credits.spendable, …): those are deprecated and will be removed, so read the dollar fields.
Headers
AuthorizationstringRequiredBearer mk_live_…: your API key. See Authentication.
Response
On success (200): The account. The JSON is { "success": true, "data": … }, and inside data:
idstringRequired- Your mnml account.
emailstringRequired- The account’s email address.
namestring | nullRequired- The account’s name;
nullwhen none is set. tierstringRequiredpaidonce the account has topped up its API wallet; it sets the limits below.freepaidbalance_usdnumberRequired- Your API wallet’s balance: what the next call can spend, in US dollars. Your Studio balance is separate.
keyobjectRequired- The key that made this call.
Fields (3)
idstringRequired- The key’s id, as the console lists it.
allowed_originsstring[]Required- Browser origins that may call with this key. Empty: server-side calls only.
daily_limit_usdnumber | nullRequired- The daily spend limit you set on this key, in US dollars;
nullfor none.
limitsobjectRequired- The limits in force for this key. See Rate limits.
Fields (5)
scopestringRequiredaccounton the free tier, where every key shares the limits;keyonce paid.accountkeyrequests_per_minuteintegerRequired- Requests per minute, other than reads.
reads_per_minuteintegerRequiredGETrequests per minute, job polls included, counted apart.concurrent_jobsintegerRequired- Jobs that may be queued or running at once.
daily_usdnumber | nullRequired- What this key may spend per UTC day, in US dollars: the tighter of your tier’s limit and the key’s own;
nullfor no limit.
Response headers (4)
X-Request-Idstring- This request, for support and the console log.
RateLimit-Limitinteger- Requests this key may make per minute.
RateLimit-Remaininginteger- Requests left in the current minute.
RateLimit-Resetinteger- Seconds until the current minute resets.
Status codes
- 200
- The account.
- 401
- The API key is missing, malformed, unknown or revoked.
- 429
- A limit was reached: requests per minute, or a daily or concurrency limit.
- Other
- Any other error, in the same envelope.
Every error answers { "success": false, "error": { "code", "message" } }. What each code means, and what to do, is on Errors.