antworkDOCS

Usage

Your plan, and how much of it you have used: posts this cycle and workspaces.

GEThttps://antwork.io/api/v1/usageScoperead

Request

curl https://antwork.io/api/v1/usage \
  -H "Authorization: Bearer $ANTWORK_API_KEY"

The same numbers the MCP list_workspaces tool reports, from the functions that enforce them. Needs the read scope.

Response

200 OK
{
  "object": "usage",
  "plan": "usage",
  "posts": {
    "used": 0,
    "limit": null,
    "remaining": null,
    "unlimited": true,
    "cycleStart": "2026-10-01T00:00:00.000Z",
    "cycleEnd": "2026-11-01T00:00:00.000Z"
  },
  "workspaces": { "used": 0, "limit": null, "remaining": null, "unlimited": true }
}
unlimited: true means the plan has no cap on that count: nothing is counted, used is 0 and limit and remaining are null. usageUnavailable: true means the count could not be taken this time, so used is unknown rather than zero. Each account's daily cap is on GET /api/v1/accounts/{id}.