usage

Management

Usage

View Scenario API usage statistics for a date range. Args: - start_date, end_date: optional ISO dates to bound the query - team_id, project_id: optional context filters - response_format: 'json' (default) or 'markdown' Returns: usage totals and breakdowns for the selected range. Examples: - "Show usage for this month" -> start_date="2026-04-01", end_date="2026-04-30" - "Show recent project usage" -> team_id="team_xxx", project_id="project_xxx" Don't use when: You need per-job execution state or cancellation. Prefer manage_jobs instead.

read-onlyidempotentopen-world

Parameters

NameTypeRequiredDescription
team_idstringTeam ID. Required if user belongs to multiple teams.
project_idstringProject ID to scope the operation to.
start_datestringStart date (ISO format).
end_datestringEnd date (ISO format).
response_formatenum(json | markdown)jsonOutput format: 'json' for structured data, 'markdown' for human-readable text.

Example Request

JSON
{
  "team_id": "team_abc123",
  "project_id": "proj_xyz789",
  "start_date": "2026-03-01",
  "end_date": "2026-03-31"
}

Example Response

JSON
{
  "usages": [
    {
      "date": "2026-03-20",
      "credits": 120
    }
  ]
}

Common Use Cases

  • Query credit usage for a date range to monitor spend
  • Compare usage across teams or projects with explicit context filters