Docs

API reference · AI gateway

Get a budget

GET/v1/orgs/{org}/ai/budgets/{budget}
Permission
ai.budgets.read
Operation
ai.budgets.get

Parameters

NameInTypeRequiredNotes
orgpathstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
budgetpathstringyesfor example "bud_01h455vb4pex5vsknk084sn02q"
x-obhut-management-assignmentheaderstringnoSelect one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q"

Response 200

FieldTypeRequiredNotes
idstringyesfor example "bud_01h455vb4pex5vsknk084sn02q"
orgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
scopeobject or object or objectyes
scope.kind"organization"yes
scope.keystringyesfor example "gwk_01h455vb4pex5vsknk084sn02q"
scope.namestringyes1 to 100 characters
keyNamestring or nullyes
limitNanoEurstringyesNano-euros (10^-9 EUR) as a decimal string. For example "50000000000"
spentNanoEurstringyesNano-euros (10^-9 EUR) as a decimal string. For example "50000000000"
createdAtstring (date-time)yesUTC, ISO 8601.
updatedAtstring (date-time)yesUTC, ISO 8601.