SCscipot
usage

Get token quota status for a workspace

Changed on

Returns the current month's token usage vs. limit for a workspace.

Use this to check remaining quota before LLM operations or to display a usage bar in the frontend. When is_limited is false, no limit applies (neither the workspace's nor its integrator's). A workspace with no limit of its own under a numeric integrator total reports that total (limited_by_integrator_total: true, tokens_remaining shared by every workspace of the integrator).

get/integrator/usage/token-quota

Request

Query parameters

workspace_idstring uuid required

Workspace ID to check

Response

Successful Response

is_allowedboolean required
tokens_usedinteger required
tokens_limitinteger required

Effective limit (base + bonus)

tokens_remaininginteger required
bonus_tokensinteger
periodstring required

Period key YYYYMM

is_limitedboolean required

False only when neither the workspace nor its integrator has a limit. A workspace with no limit of its own under a numeric integrator total reports that total (is_limited true, tokens_limit/tokens_remaining the integrator's), since it is what stops the workspace.

scope'workspace' | 'integrator'

Which limit blocks, or would block first: the workspace's own (clamped to the integrator's per-workspace ceiling), or the integrator's monthly total over all its workspaces (only when that total is exhausted).

integrator_tokens_usedinteger nullable

The integrator's month over all workspaces, when capped.

integrator_tokens_limitinteger nullable

The operator's monthly total (None = no total).

limited_by_integrator_totalboolean

True when the workspace has no limit of its own and tokens_limit/tokens_remaining are the integrator's shared total (v0.7.51.0).

Changes

  • 34be7df24641Revision changes
    • info

      added the optional property to the response with the status

  • 8da65b524a16Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status