get · usage:read

Plan usage

Plan and mentions used against the quota. Check it before creating monitors if the project is near its limit.

Read onlyIdempotent

REST

get/api/v1/usage
curl "https://herculeradar.com/api/v1/usage" \
  --header "Authorization: Bearer hr_live_…"

MCP

Tool name get_usage. It takes the same input and returns the same { data, meta } envelope as REST, because both call the same function.

Plan and mentions used against the quota. Check before creating monitors if the user is near their limit.

Response

{
  "data": {
    "plan": "starter",
    "quota_period": "monthly",
    "mentions_included": 1000,
    "mentions_used": 412,
    "mentions_remaining": 588,
    "period_start": "2026-09-01",
    "provider_cost_usd": 0.842,
    "cost_per_new_mention_usd": 0.00204
  },
  "meta": {
    "capability": "get_usage",
    "requestId": "req_9f2b4a8c1d0e",
    "idempotencyReplayed": false,
    "docs": "https://herculeradar.com/docs/reference/get_usage"
  }
}

Authorization

Requires the usage:read scope. A credential without it gets 403 FORBIDDEN. Resources in projects the credential cannot reach answer 404 NOT_FOUND rather than 403, so ids cannot be probed across tenants.