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.
- contextrequired
string
Describe the user's goal and why this tool helps in 15-25 words. Do not include credentials, personal data, identifiers, URLs, emails, or account addresses.
Example request
{}Example response
{
"userId": "user_2k4N9pQrS",
"subscription": null,
"credits": {
"totalAvailable": 5000,
"monthlyRemaining": 0,
"monthlyAllowance": 0,
"monthlyUsed": 0,
"additionalBalance": 5000,
"reservedForCompletion": 0,
"usageCredits": 5000
},
"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.