GEgetaxonflow
Cost Controls

Create a budget

Create a new budget with spending limits. Budgets can be scoped to organization, team, agent, workflow, or user level.

Enterprise only. These routes are not registered in Community edition, which returns 404 Not Found.

post/api/v1/budgets

Request

Headers

X-Org-IDstring required

Organization ID

Request body

idstring required
namestring required
scope'organization' | 'team' | 'agent' | 'workflow' | 'user' required
scope_idstring
limit_usdnumber double required
period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required
on_exceed'warn' | 'block' | 'downgrade'
alert_thresholdsinteger[]

Response

Budget created

idstring required

Unique budget identifier

namestring required

Human-readable budget name

enabledboolean

When false the budget is configured but its limit is not enforced — usage is still tracked. Lets operators dry-run a budget before flipping it on.

scope'organization' | 'team' | 'agent' | 'workflow' | 'user' required

Budget scope level

scope_idstring

ID of the scoped entity (team_id, agent_id, etc.)

limit_usdnumber double required

Maximum spending limit in USD

period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required

Budget reset period

on_exceed'warn' | 'block' | 'downgrade'

Action when budget is exceeded

alert_thresholdsinteger[]

Percentage thresholds for alerts (e.g., [50, 80, 100])

org_idstring

Organization ID

tenant_idstring

Tenant ID (multi-tenant deployments)

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.