API reference · AI gateway
Create a budget in EUR for the organization, a key, or a named group of keys
POST/v1/orgs/{org}/ai/budgets
- Permission
ai.budgets.manage- Audit log
ai.budget.create- Operation
ai.budgets.create
Parameters
| Name | In | Type | Required | Notes |
|---|
org | path | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
Idempotency-Key | header | string | no | One key per intended mutation. A retry with the key replays the recorded response instead of executing again; the key with another request answers 422 idempotency_key_reused. For example "01h455vb4pex5vsknk084sn02q" |
x-obhut-management-assignment | header | string | no | Select one staff assignment. Direct membership remains the default. Bound API tokens use their stored source and ignore this selector. For example "masg_01h455vb4pex5vsknk084sn02q" |
Request body
| Field | Type | Required | Notes |
|---|
scope | object or object or object | yes | |
scope.kind | "organization" | yes | |
scope.key | string | yes | for example "gwk_01h455vb4pex5vsknk084sn02q" |
scope.name | string | yes | 1 to 100 characters |
limitNanoEur | string | yes | Nano-euros (10^-9 EUR) as a decimal string. For example "50000000000" |
Response 201
| Field | Type | Required | Notes |
|---|
id | string | yes | for example "bud_01h455vb4pex5vsknk084sn02q" |
orgId | string | yes | for example "org_01h455vb4pex5vsknk084sn02q" |
scope | object or object or object | yes | |
scope.kind | "organization" | yes | |
scope.key | string | yes | for example "gwk_01h455vb4pex5vsknk084sn02q" |
scope.name | string | yes | 1 to 100 characters |
keyName | string or null | yes | |
limitNanoEur | string | yes | Nano-euros (10^-9 EUR) as a decimal string. For example "50000000000" |
spentNanoEur | string | yes | Nano-euros (10^-9 EUR) as a decimal string. For example "50000000000" |
createdAt | string (date-time) | yes | UTC, ISO 8601. |
updatedAt | string (date-time) | yes | UTC, ISO 8601. |