get_workspace_credits

AI credits are what site generation spends. get_workspace also carries a balance, but that one is the stored figure and can be stale right after a renewal or a top up, so use this tool when the number has to be right.

Before answering, it applies any monthly reset or allowance change that is due. The answer is the buckets in AiCredits, so the balance is SubscriptionLimit minus SubscriptionUsage plus TopUpCredits, and SubscriptionResetAt is the date of the next monthly reset, null on the Free plan. See Credits.

Request

Call it with a POST to https://api.modulify.ai/v1/get_workspace_credits, sending the inputs below as a JSON object. The token needs the workspaces:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/get_workspace_credits \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"WORKSPACE_ID"}'

Over MCP, the same method is the get_workspace_credits tool.

Inputs

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.