FruxonDocs
AgentsBudget

Removes a single optional budget cap

Deletes the cap identified by (origin, environment, period). The mandatory agent-wide daily, weekly, and monthly caps (on Production and Test) cannot be removed — a request targeting one returns 400. Use this to drop a per-environment cap. Historical cost data is unaffected.

DELETE
/v1/tenants/{tenant}/agents/{agent}/budget
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The agent ID.

tenant*string

The tenant identifier

Query Parameters

origin?string

Which spend bucket to clear — default PRODUCTION; pass TEST for the developer test bucket.

Value in"UNSPECIFIED" | "PRODUCTION" | "TEST"
environment?string

Which environment's cap to clear. Omitted (default) targets the agent-wide cap; a slug targets only that environment's cap.

period?string

Which window's cap to clear — default MONTHLY; pass WEEKLY or DAILY.

Value in"UNSPECIFIED" | "DAILY" | "WEEKLY" | "MONTHLY"

Response Body

curl -X DELETE "https://api.fruxon.com/v1/tenants/string/agents/string/budget"
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Lists every budget cap for an agent — one per (origin, environment, period).

One round-trip for the studio budget panel: returns Production and Test budgets, agent-wide and per-environment, across all windows (daily/weekly/monthly), in a single array. Agent-wide rows carry `environment: null`; environment-scoped rows name their slug. Always includes the mandatory agent-wide daily, weekly, and monthly caps on each bucket. The single-bucket M:Fruxon.Server.Controllers.AgentBudgetController.Get(System.String,Fruxon.Model.AgentSessions.ExecutionOrigin,System.String,Fruxon.Model.AgentBudgets.BudgetPeriod) endpoint is still the right call when you only care about one cap; this one is for rendering the full configuration UI.

Creates or updates the budget configuration for an agent

Upserts a single cap in place, identified by (origin, environment, period) — the same call creates the cap if none exists or replaces the existing one. The window is taken from `period` in the body (default `MONTHLY`); several caps on different windows can coexist on one bucket and all enforce together. Once a cap is set, the execution engine rejects new runs that would push that window's accumulated cost above it, and alert thresholds fire notifications as usage crosses them. The mandatory agent-wide daily, weekly, and monthly caps (on Production and Test) cannot be removed — set `enforceLimit: false` for a notify-only cap instead; optional caps can be removed via M:Fruxon.Server.Controllers.AgentBudgetController.Delete(System.String,Fruxon.Model.AgentSessions.ExecutionOrigin,System.String,Fruxon.Model.AgentBudgets.BudgetPeriod).