Skip to main content
GET
Get a workspace budget control

Authorizations

Authorization
string
header
required

Monid API key (Authorization: Bearer mk_...) or Clerk-issued JWT. Each operation lists the ONE scope an API key needs. {resource}:* grants every action on that resource; * grants everything; Clerk sessions hold *. Operations with an empty list need no scope. Scope catalog: GET /v1/api-keys/scopes.

Headers

X-Monid-Agent-Model
string

Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256
X-Monid-Agent-Harness
string

Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256
X-Monid-Agent-Session-Id
string

Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256

Path Parameters

budgetControlId
string
required

Budget control ID (ULID).

Example:

"01JC2Z0A9V8Q4R6T8Y0B2D4F6H"

Response

Budget control

budgetControlId
string
required

Budget control ID (ULID).

Example:

"01JC2Z0A9V8Q4R6T8Y0B2D4F6H"

workspaceId
string
required
period
enum<string>
required
Available options:
HOUR,
DAY,
WEEK,
MONTH
limitAmount
number
required

Budget cap for the window, in dollars.

Example:

100

spentAmount
number
required

Settled spend in the current window, in dollars.

heldAmount
number
required

Outstanding holds for in-flight runs, in dollars.

availableAmount
number
required

limitAmount - spentAmount - heldAmount, in dollars.

currency
enum<string>
required
Available options:
USD
windowStart
string<date-time>
required

ISO 8601 — which window the counters represent.

status
enum<string>
required
Available options:
ACTIVE,
PAUSED
createdAt
string<date-time>
required
updatedAt
string<date-time>
required