Citera home
Browse documentation

Usage

Usage

Read effective API/MCP consumption, credits, and limits.

Summarize with AIChatGPTClaudePerplexity

GET /v1/usage

Scopes (any): usage:read, keys:manage. A session token is also accepted. Costs 1 request unit and no credits. Identity comes from authentication; you cannot query another user or key.

{
  "data": {
    "object": "api_usage",
    "tier": "scale",
    "shared_surfaces": ["api", "mcp"],
    "credit_unit": "operation_unit",
    "owner": {
      "minute_requests": { "used": 3,  "limit": 600,    "remaining": 597,   "resets_at": "…" },
      "day_requests":    { "used": 120, "limit": 100000, "remaining": 99880, "resets_at": "…" },
      "monthly_credits": { "used": 42, "limit": 500,    "remaining": 458,   "resets_at": "…" }
    },
    "current_key": { "...same shape for this key, null for sessions...": "" },
    "queue_priority": 5,
    "priority_applies_to": "waiting_api_jobs",
    "operation_costs": { "generation": { "blog_post": 5, "...": 2 }, "preview": 1, "publish": 3,
                         "refresh_results": 1, "reschedule_publication": 1, "run_local": 5,
                         "website_publish": 3, "website_recheck": 1, "website_mode": 1,
                         "reads": 0, "internal_edits": 0, "recovery": 0 }
  },
  "request_id": "req_…"
}
{
  "data": {
    "object": "api_usage",
    "tier": "scale",
    "shared_surfaces": ["api", "mcp"],
    "credit_unit": "operation_unit",
    "owner": {
      "minute_requests": { "used": 3,  "limit": 600,    "remaining": 597,   "resets_at": "…" },
      "day_requests":    { "used": 120, "limit": 100000, "remaining": 99880, "resets_at": "…" },
      "monthly_credits": { "used": 42, "limit": 500,    "remaining": 458,   "resets_at": "…" }
    },
    "current_key": { "...same shape for this key, null for sessions...": "" },
    "queue_priority": 5,
    "priority_applies_to": "waiting_api_jobs",
    "operation_costs": { "generation": { "blog_post": 5, "...": 2 }, "preview": 1, "publish": 3,
                         "refresh_results": 1, "reschedule_publication": 1, "run_local": 5,
                         "website_publish": 3, "website_recheck": 1, "website_mode": 1,
                         "reads": 0, "internal_edits": 0, "recovery": 0 }
  },
  "request_id": "req_…"
}
{
  "data": {
    "object": "api_usage",
    "tier": "scale",
    "shared_surfaces": ["api", "mcp"],
    "credit_unit": "operation_unit",
    "owner": {
      "minute_requests": { "used": 3,  "limit": 600,    "remaining": 597,   "resets_at": "…" },
      "day_requests":    { "used": 120, "limit": 100000, "remaining": 99880, "resets_at": "…" },
      "monthly_credits": { "used": 42, "limit": 500,    "remaining": 458,   "resets_at": "…" }
    },
    "current_key": { "...same shape for this key, null for sessions...": "" },
    "queue_priority": 5,
    "priority_applies_to": "waiting_api_jobs",
    "operation_costs": { "generation": { "blog_post": 5, "...": 2 }, "preview": 1, "publish": 3,
                         "refresh_results": 1, "reschedule_publication": 1, "run_local": 5,
                         "website_publish": 3, "website_recheck": 1, "website_mode": 1,
                         "reads": 0, "internal_edits": 0, "recovery": 0 }
  },
  "request_id": "req_…"
}
{
  "data": {
    "object": "api_usage",
    "tier": "scale",
    "shared_surfaces": ["api", "mcp"],
    "credit_unit": "operation_unit",
    "owner": {
      "minute_requests": { "used": 3,  "limit": 600,    "remaining": 597,   "resets_at": "…" },
      "day_requests":    { "used": 120, "limit": 100000, "remaining": 99880, "resets_at": "…" },
      "monthly_credits": { "used": 42, "limit": 500,    "remaining": 458,   "resets_at": "…" }
    },
    "current_key": { "...same shape for this key, null for sessions...": "" },
    "queue_priority": 5,
    "priority_applies_to": "waiting_api_jobs",
    "operation_costs": { "generation": { "blog_post": 5, "...": 2 }, "preview": 1, "publish": 3,
                         "refresh_results": 1, "reschedule_publication": 1, "run_local": 5,
                         "website_publish": 3, "website_recheck": 1, "website_mode": 1,
                         "reads": 0, "internal_edits": 0, "recovery": 0 }
  },
  "request_id": "req_…"
}

limit/remaining are null when unlimited.