Skip to main content
POST
Set the synthesis budget
Sets monthlyCapCents (an integer of at least 1) and, when sent, alertThresholdPercent (an integer from 1 to 99) and rollingWindowDays (an integer from 1 to 365), the Console’s bounds. A field you leave out keeps its value; a new budget takes the defaults for it. Spend so far is unchanged. The answer is 200 with the budget. A repeat converges on the same state. Needs synthesis:manage, and the credential’s scopes must also reach platform:read, because the answer is a read of what was written; a credential missing either is refused 403 before anything runs. Both must then be held at the platform scope: a grant that covers only some org units receives 403 naming the first one missing, and nothing is written. A Personal key writes as its owner; an External App or platform key is recorded as itself (see Who wrote it). Send an Idempotency-Key to make a retry safe: the same key and body within 24 hours returns the recorded answer only while your scopes still reach platform:read and you still hold platform:read and synthesis:manage at the platform scope; otherwise 409 idempotency_result_unavailable, and the write never runs twice. The same key with a different body is 422. See Synthesis settings writes.

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.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Body

application/json
monthlyCapCents
integer
required

The monthly synthesis spend cap, in cents; at least 1.

Required range: x >= 1
alertThresholdPercent
integer

Alert when spend reaches this percent of the cap (1-99); kept when omitted.

Required range: 1 <= x <= 99
rollingWindowDays
integer

The spend window in days (1-365); kept when omitted.

Required range: 1 <= x <= 365

Response

The budget

data
object
required
meta
object
required