Orq.ai · Schema

UpdateBudgetRequest

Artificial IntelligencePlatformEnterpriseGovernanceSoftwareFactory

Properties

Name Type Description
limits object New limits. Omit to keep current.
rate_limit object New rate limit. Omit to keep current.
is_active boolean New active state. Omit to keep current.
expires_at string New expiration. Omit to keep current. Set `clear_expires_at = true` to remove an existing expiration.
clear_expires_at boolean Force-clear the expiration. Mutually exclusive with `expires_at`.
match object New matching expression. Only valid for dynamic budgets (no structured scope) — the scope of a scoped budget is immutable, so its derived expression is too. Validated via CEL parse.
alerts array Replaces the alert list wholesale. Omit to keep the current alerts. An entry with a known `id` is edited in place; one with no id is minted.
clear_alerts boolean Force-clear every alert. Mutually exclusive with a non-empty `alerts`.
View JSON Schema on GitHub

JSON Schema

orq-update-budget-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/orq/json-schema/orq-update-budget-request-schema.json",
  "title": "UpdateBudgetRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/orq-budgets-api-openapi.yml#/components/schemas/UpdateBudgetRequest",
  "type": "object",
  "properties": {
    "limits": {
      "allOf": [
        {
          "$ref": "#/$defs/BudgetLimits"
        }
      ],
      "description": "New limits. Omit to keep current."
    },
    "rate_limit": {
      "allOf": [
        {
          "$ref": "#/$defs/RateLimit"
        }
      ],
      "description": "New rate limit. Omit to keep current."
    },
    "is_active": {
      "type": "boolean",
      "description": "New active state. Omit to keep current."
    },
    "expires_at": {
      "type": "string",
      "description": "New expiration. Omit to keep current. Set `clear_expires_at = true`\n to remove an existing expiration.",
      "format": "date-time"
    },
    "clear_expires_at": {
      "type": "boolean",
      "description": "Force-clear the expiration. Mutually exclusive with `expires_at`."
    },
    "match": {
      "allOf": [
        {
          "$ref": "#/$defs/BudgetMatch"
        }
      ],
      "description": "New matching expression. Only valid for dynamic budgets (no\n structured scope) — the scope of a scoped budget is immutable, so\n its derived expression is too. Validated via CEL parse."
    },
    "alerts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BudgetAlert"
      },
      "description": "Replaces the alert list wholesale. Omit to keep the current alerts.\n An entry with a known `id` is edited in place; one with no id is minted."
    },
    "clear_alerts": {
      "type": "boolean",
      "description": "Force-clear every alert. Mutually exclusive with a non-empty `alerts`."
    }
  },
  "$defs": {
    "BudgetAlert": {
      "required": [
        "threshold_percent",
        "notifier_ids"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Assigned by ORQ. Supply an existing id to edit that alert in place."
        },
        "threshold_percent": {
          "type": "integer",
          "description": "Percentage of the dimension's limit at which the alert fires, 1–100.",
          "format": "uint32"
        },
        "notifier_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Must be workspace-scoped; project-scoped notifiers are rejected."
        },
        "dimension": {
          "description": "Defaults to COST when unset.",
          "$ref": "#/$defs/BudgetAlertDimension"
        }
      },
      "description": "Notifies every listed notifier once current-period consumption on\n `dimension` reaches `threshold_percent` of the matching limit. Each alert\n fires at most once per period, re-arming on rollover or a limit change.\n The dimension must have a limit set, or the write is rejected. A TOKENS alert is rejected."
    },
    "BudgetAlertDimension": {
      "type": "string",
      "enum": [
        "BUDGET_ALERT_DIMENSION_COST",
        "BUDGET_ALERT_DIMENSION_TOKENS"
      ]
    },
    "BudgetLimits": {
      "type": "object",
      "properties": {
        "period": {
          "$ref": "#/$defs/BudgetPeriod"
        },
        "amount": {
          "type": "number",
          "format": "double"
        },
        "token_limit": {
          "type": "number",
          "description": "Token ceiling for the budget period. Token counts are whole numbers\n and stored as integers.",
          "format": "double"
        }
      },
      "description": "BudgetLimits is the per-period spend and token ceiling. At least one\n of `amount`, `token_limit`, or RateLimit.requests_per_minute MUST be\n set on a Budget; that invariant is enforced by the handler."
    },
    "BudgetMatch": {
      "type": "object",
      "properties": {
        "cel": {
          "type": "string"
        }
      },
      "description": "CEL expression that decides whether a budget applies to a request. Available variables: `model`, `provider`, `model_id`, `api_key`, `identity`, `project`, `metadata` (map), `headers` (map, lowercase keys). An empty expression always matches. Expressions are syntax-validated at write time."
    },
    "BudgetPeriod": {
      "type": "string",
      "enum": [
        "BUDGET_PERIOD_DAILY",
        "BUDGET_PERIOD_WEEKLY",
        "BUDGET_PERIOD_MONTHLY",
        "BUDGET_PERIOD_YEARLY",
        "BUDGET_PERIOD_ONE_TIME"
      ]
    },
    "RateLimit": {
      "type": "object",
      "properties": {
        "requests_per_minute": {
          "type": "integer",
          "format": "int32"
        }
      },
      "description": "Per-minute request ceiling applied to the requests this budget\n matches."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/orq-update-budget-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.