Tool Reference

get_credits

Get current credit balance and usage.

Get the current credit balance including available credits, reserved (in-flight) credits, usage this month, monthly limit, and reset date. Check this before running a workflow to ensure sufficient credits.

Parameters

This tool takes no user-supplied parameters.

Parameter Type Required Description
companyId string Auto-injected Injected from your API key. Do not pass this.

Example Request

curl -X POST https://socialcrm.com/api/mcp-app \
  -H "Authorization: Bearer sk_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "tools/call",
    "params": {
      "name": "get_credits",
      "arguments": {}
    }
  }'

Example Response

Parsed from result.content[0].text:

{
  "available": 425,
  "reserved": 25,
  "used_this_month": 50,
  "monthly_limit": 500,
  "reset_date": "2026-03-01T00:00:00.000Z"
}

Output Schema

Field Type Description
available number Credits available to spend right now
reserved number Credits reserved by currently running workflows
used_this_month number Credits consumed so far this billing cycle
monthly_limit number Total monthly credit allocation for your plan
reset_date string ISO 8601 date when credits reset for the next billing cycle

Notes

  • available = monthly_limit - used_this_month - reserved.
  • Credits reserved by a running workflow are released if the workflow fails or is cancelled.
  • Check available against a workflow's creditCost (from list_workflows) before calling run_workflow.