Usage API

Workspace usage reporting.

📄️Get current month budget and usage

The company's budget position for the current calendar month (UTC): the plan's monthly budget, what the metered usage has cost so far, what is left, and the metered quantities behind that number. Read it before starting a large job: once `budget.exceeded` is true every metered operation (document ingestion, search, messages) answers 402 with `code: 'budget-exceeded'` until the month rolls over or the budget is raised. Creating collections and folders is not metered and keeps working. Ingestion is metered per processed page and per media minute, not per file, so cost tracks pages and images rather than file count.

📄️Generate usage report (PDF or JSON)

Answers a PDF attachment, or JSON with `mode=json`. Accepts a `start`/`end` day range (or the legacy `year`/`month` pair), an optional CSV of application ids and a `mode` of `detailed` (default), `summary` or `json`. The JSON mode carries the same totals as the PDF: quantity per metered unit, the per-application pivot and the raw events, for automation. For the current month budget position use `getUsage` instead.