Skip to main content
PATCH
Update the spend cap and/or the alert thresholds

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Validation for PUT /v1/usage/budget.

Every field is optional — a client sends only what it wants to change, and an empty body is a no-op that returns current state (per the documented contract in docs-site/ai-api/control/budget.mdx). spend_cap and alert_thresholds accept an explicit null to clear, which is semantically distinct from an omitted key (leave unchanged); the controller distinguishes the two via has() rather than the validated value.

spend_cap
integer | null
Required range: 0 <= x <= 1000000000000
alert_thresholds
integer[] | null
Maximum array length: 3
Required range: 1 <= x <= 100

Response

Updated budget settings.

success
boolean
required
data
object
required