Sign in
LLM Usage

Get the workspace's LLM usage report for one month

Changed on
get/workspaces/{workspaceSlug}/llm/usage

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/llm/usage
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Query parameters

monthstring

Response

OK

instanceBudgetVerdict'WITHIN' | 'EXHAUSTED' | 'UNVERIFIABLE' required

Whether host-funded (shared-model) spend is within its cap, has reached it, or cannot be confirmed because some shared-model usage has no price set.

instanceMonthlyBudgetUsdnumber

Monthly cap in USD on spend the host pays for (shared models); null = uncapped. Set by instance admins only — a workspace admin can see it but not change it.

instancePausedboolean required

Whether work on SHARED models is currently paused for this workspace. Authoritative — it mirrors the live gate rather than being derivable from the verdict alone. Always false for a past month, which cannot pause anything.

instanceTotalCostUsdnumber required

This month's confirmed spend on shared (instance) models, in USD — the figure instanceMonthlyBudgetUsd compares against. A floor, not the full total, while unpricedEventCount is non-zero.

monthstring required

Calendar month (UTC), ISO yyyy-MM

ownProviderBudgetVerdict'WITHIN' | 'EXHAUSTED' | 'UNVERIFIABLE' required

The same verdict for spend on this workspace's own provider, against its own cap.

ownProviderMonthlyBudgetUsdnumber

Monthly cap in USD on spend this workspace pays for through its own connected provider; null = uncapped. Set by this workspace's own admins.

ownProviderPausedboolean required

Whether work on this workspace's OWN provider is currently paused.

ownProviderTotalCostUsdnumber required

This month's confirmed spend on this workspace's own connected provider(s), in USD — the figure ownProviderMonthlyBudgetUsd compares against. Different money from instanceTotalCostUsd: the two are never added together.

unpricedEventCountinteger required

Calls this month (either purse) whose price is not yet known. They are excluded from both totals above, so a non-zero value means the real spend may be higher than shown.

Example response

{
  "fx": {
    "currencyCode": "EUR",
    "rateDate": "2026-07-24",
    "ratePerUsd": 0.878966,
    "source": "ECB"
  },
  "month": "2026-07"
}

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$