mint:read

Get Credits Balance

get_credits_balance

Shows available monthly and Usage Credits plus any balance reserved to finish a workflow.

Parameters

Input schema generated from the registry. Required parameters are tagged.

No input parameters.

Example request

{}

Example response

{
  "userId": "user_2k4N9pQrS",
  "subscription": null,
  "credits": {
    "totalAvailable": 25000,
    "monthlyRemaining": 0,
    "monthlyAllowance": 0,
    "monthlyUsed": 0,
    "additionalBalance": 25000,
    "reservedForCompletion": 0,
    "usageCredits": 25000
  },
  "preview": {
    "unitCost": 5,
    "canAfford": true
  },
  "final": {
    "unitCost": 60,
    "canAfford": true
  }
}

Use cases

• Check before starting a generation that costs final credits.
• Explain how much balance is available or reserved before generation.