GEgetaxonflow
Cost Controls

Check budget before request

Check if a request should be allowed based on budget constraints. Returns whether the request is allowed and the applicable budget status.

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

post/api/v1/budgets/check

Request

Request body

org_idstring required
team_idstring
agent_idstring
workflow_idstring
user_idstring

Response

Budget check result

allowedboolean

Whether the request should be allowed

action'warn' | 'block' | 'downgrade'

Action that was taken (if budget exceeded)

budget_idstring

ID of the budget that blocked the request

budget_namestring
used_usdnumber double
limit_usdnumber double
percentagenumber double
messagestring

Changes

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