Component schema

AgenticWorkflowCreditBudget

object1 direct reference

Definition

numberrequired

The maximum number of credits this workflow may consume within the rolling window.

The rolling time window over which credit spend is summed (e.g. 24h, 7d, 4w).

number

Optional warning threshold, as a percentage (0-100) of credits. A budget_warning notification is dispatched once, to notifications.onBudgetWarningChannels, the first time a completed run pushes rolling spend across this percentage of the budget. Leave unset to disable budget warnings.

Used by 1

These schemas and endpoints reference this type directly.

SchemaAgenticWorkflowGuardrails

json

OpenAPI source12345678910111213141516171819202122
{
  "properties": {
    "credits": {
      "description": "The maximum number of credits this workflow may consume within the rolling window.\n",
      "type": "number"
    },
    "window": {
      "$ref": "#/components/schemas/Duration",
      "description": "The rolling time window over which credit spend is summed (e.g. `24h`, `7d`, `4w`).\n"
    },
    "warningThreshold": {
      "description": "Optional warning threshold, as a percentage (0-100) of `credits`. A `budget_warning`\nnotification is dispatched once, to `notifications.onBudgetWarningChannels`, the first time\na completed run pushes rolling spend across this percentage of the budget. Leave unset to\ndisable budget warnings.\n",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  },
  "required": [
    "credits",
    "window"
  ]
}