Controls

Get a workspace budget control

Changed on
get/v1/controls/workspace/budgets/{budgetControlId}

Request

  • Base URL: https://api.monid.ai
  • URL: https://api.monid.ai/v1/controls/workspace/budgets/{budgetControlId}
  • Auth: HTTP bearer

Path parameters

budgetControlIdstring required

Budget control ID (ULID).

Example:01JC2Z0A9V8Q4R6T8Y0B2D4F6H

Headers

X-Monid-Agent-Modelstring

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

X-Monid-Agent-Harnessstring

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).

X-Monid-Agent-Session-Idstring

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).

Response

Budget control

budgetControlIdstring required

Budget control ID (ULID).

workspaceIdstring required
period'HOUR' | 'DAY' | 'WEEK' | 'MONTH' required
limitAmountnumber required

Budget cap for the window, in dollars.

spentAmountnumber required

Settled spend in the current window, in dollars.

heldAmountnumber required

Outstanding holds for in-flight runs, in dollars.

availableAmountnumber required

limitAmount - spentAmount - heldAmount, in dollars.

currency'USD' required
windowStartstring date-time required

ISO 8601 — which window the counters represent.

status'ACTIVE' | 'PAUSED' required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "budgetControlId": "01JC2Z0A9V8Q4R6T8Y0B2D4F6H",
  "limitAmount": 100
}

Changes

  • 631143e91790Revision changes
    • info

      added the new optional header request parameter X-Monid-Agent-Harness

    • info

      added the new optional header request parameter X-Monid-Agent-Model

    • info

      added the new optional header request parameter X-Monid-Agent-Session-Id

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

  • b944bb23906cRevision changes
    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • info

      added the non-success response with the status