Skip to main content
GET
Get the synthesis budget
Returns {budget, defaults}. budget is the workspace’s monthly synthesis spend cap and where it stands: monthlyCapCents, alertThresholdPercent, rollingWindowDays, currentMonthSpendCents (spend reserved and reconciled in the current window), utilizationPercent, windowStartAt and alertedAt (when the threshold alert last fired, or null). It is null before a budget is set. defaults are the values the Console offers for a new budget. The route takes no query parameter: any parameter is 400. Needs platform:read at the platform scope (Console parity): a grant that covers only some org units receives 403.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

The budget and the defaults

data
object
required
meta
object
required