Usage

Monitor your API consumption with monthly summaries and daily breakdowns.

Monthly summary

GET /usage

Returns the current month summary including total calls, remaining allowance, and top endpoints. Auth required. Cost: 0.

Response:

{
  "period": "2026-04",
  "monthly_limit": 10000,
  "used": 347,
  "remaining": 9653,
  "top_endpoints": [
    {"endpoint": "/inbox", "method": "POST", "calls": 120},
    {"endpoint": "/notebook", "method": "GET", "calls": 98},
    {"endpoint": "/actors", "method": "GET", "calls": 65}
  ]
}

Daily history

GET /usage/history

Returns a daily breakdown of API calls for the current month. Auth required. Cost: 0.

Response:

{
  "period": "2026-04",
  "daily": [
    {"day": "2026-04-01", "calls": 42},
    {"day": "2026-04-02", "calls": 38},
    {"day": "2026-04-03", "calls": 55}
  ]
}

Examples

Check monthly usage

curl https://roots.chatforest.com/api/v1/usage \
  -H "X-API-Key: $ROOTS_API_KEY"

View daily breakdown