Update llm gateway budget

PUT

api

headless

organizations

{organizationId}

llm-gateway

budgets

{budgetId}

Update llm gateway budget

curl --request PUT \
  --url https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Forge-Confirm: <x-forge-confirm>' \
  --header 'X-Forge-Reason: <x-forge-reason>' \
  --data '
{
  "updatedAt": "2023-11-07T05:31:56Z",
  "amountUsd": 500000000000
}
'

import requests

url = "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId}"

payload = {
    "updatedAt": "2023-11-07T05:31:56Z",
    "amountUsd": 500000000000
}
headers = {
    "X-Forge-Reason": "<x-forge-reason>",
    "Idempotency-Key": "<idempotency-key>",
    "X-Forge-Confirm": "<x-forge-confirm>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Forge-Reason': '<x-forge-reason>',
    'Idempotency-Key': '<idempotency-key>',
    'X-Forge-Confirm': '<x-forge-confirm>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({updatedAt: '2023-11-07T05:31:56Z', amountUsd: 500000000000})
};

fetch('https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId}"

	payload := strings.NewReader("{\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"amountUsd\": 500000000000\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Forge-Reason", "<x-forge-reason>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Forge-Confirm", "<x-forge-confirm>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "budget": {
    "id": "<string>",
    "budgetWindow": "daily",
    "state": "active",
    "metadata": {
      "memberLimitUsd": 500000000000,
      "memberLimitsUsd": {},
      "allowance": {
        "amountUsd": 500000000000,
        "windowStart": "2023-11-07T05:31:56Z"
      },
      "memberAllowances": {},
      "memberOfBudget": "<string>",
      "memberGroupId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accessProfileId": "<string>",
    "tokenId": "<string>",
    "subjectKind": "user",
    "subjectId": "<string>",
    "amountUsd": 123,
    "inputTokenLimit": 123,
    "outputTokenLimit": 123,
    "totalTokenLimit": 123,
    "spentUsd": 123,
    "usedTokens": 123,
    "effectiveAmountUsd": 123
  }
}

{
  "budget": {
    "id": "<string>",
    "budgetWindow": "daily",
    "state": "active",
    "metadata": {
      "memberLimitUsd": 500000000000,
      "memberLimitsUsd": {},
      "allowance": {
        "amountUsd": 500000000000,
        "windowStart": "2023-11-07T05:31:56Z"
      },
      "memberAllowances": {},
      "memberOfBudget": "<string>",
      "memberGroupId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accessProfileId": "<string>",
    "tokenId": "<string>",
    "subjectKind": "user",
    "subjectId": "<string>",
    "amountUsd": 123,
    "inputTokenLimit": 123,
    "outputTokenLimit": 123,
    "totalTokenLimit": 123,
    "spentUsd": 123,
    "usedTokens": 123,
    "effectiveAmountUsd": 123
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Enter a Forge service-account token or delegated OAuth access token. Mintlify adds the Bearer prefix.

Headers

X-Forge-Reason

string

required

Minimum string length: 1

Idempotency-Key

string

required

Minimum string length: 1

X-Forge-Confirm

enum<boolean>

required

Available options:

true

Path Parameters

organizationId

string

required

budgetId

string

required

Body

application/json

Independent optional limit. All matching budgets apply cumulatively across providers and keys. Access assignments do not create budgets.

updatedAt

string<date-time>

required

Last read version; stale writes return 409.

accessProfileId

string

Optional profile filter; omission applies across access profiles.

tokenId

string

subjectKind

enum<string>

Available options:

user,

group,

app,

agent,

service_account,

customer_tenant

subjectId

string

budgetWindow

enum<string>

Available options:

daily,

weekly,

monthly,

rolling_24h,

rolling_7d,

rolling_30d

amountUsd

number<double>

Required range: 0.000001 <= x < 1000000000000

inputTokenLimit

integer<int64>

Required range: x >= 1

outputTokenLimit

integer<int64>

Required range: x >= 1

totalTokenLimit

integer<int64>

Required range: x >= 1

action

enum<string>

Available options:

block

metadata

object

Accepted budget settings. Unknown keys are rejected. Server-owned fields may be returned unchanged on update; use allowanceUsd to change allowances.

Show child attributes

state

enum<string>

Omission preserves the existing state.

Available options:

active,

disabled

allowanceUsd

number<double>

Add this USD amount to the current UTC calendar-period allowance; zero removes the entire selected allowance. Requires an active USD cap and does not reset usage or bypass other budgets. Ordinary budget fields are ignored for this action. A 202 response means runtime propagation is pending.

Required range: x >= 0

allowanceUserId

string

Optional member user ID; omission targets the group or user total.

allowanceWindowStart

string<date-time>

Optional expected UTC period start for a grant. A changed period returns 409 without granting allowance. Omission grants in the current period at processing time. Ignored when allowanceUsd is zero.

Response

Gateway budget response.

budget

object

required

Show child attributes

Update llm gateway budget

curl --request PUT \
  --url https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Forge-Confirm: <x-forge-confirm>' \
  --header 'X-Forge-Reason: <x-forge-reason>' \
  --data '
{
  "updatedAt": "2023-11-07T05:31:56Z",
  "amountUsd": 500000000000
}
'

import requests

url = "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId}"

payload = {
    "updatedAt": "2023-11-07T05:31:56Z",
    "amountUsd": 500000000000
}
headers = {
    "X-Forge-Reason": "<x-forge-reason>",
    "Idempotency-Key": "<idempotency-key>",
    "X-Forge-Confirm": "<x-forge-confirm>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'X-Forge-Reason': '<x-forge-reason>',
    'Idempotency-Key': '<idempotency-key>',
    'X-Forge-Confirm': '<x-forge-confirm>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({updatedAt: '2023-11-07T05:31:56Z', amountUsd: 500000000000})
};

fetch('https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.forge.ai/api/headless/v1/organizations/{organizationId}/llm-gateway/budgets/{budgetId}"

	payload := strings.NewReader("{\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"amountUsd\": 500000000000\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Forge-Reason", "<x-forge-reason>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-Forge-Confirm", "<x-forge-confirm>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "budget": {
    "id": "<string>",
    "budgetWindow": "daily",
    "state": "active",
    "metadata": {
      "memberLimitUsd": 500000000000,
      "memberLimitsUsd": {},
      "allowance": {
        "amountUsd": 500000000000,
        "windowStart": "2023-11-07T05:31:56Z"
      },
      "memberAllowances": {},
      "memberOfBudget": "<string>",
      "memberGroupId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accessProfileId": "<string>",
    "tokenId": "<string>",
    "subjectKind": "user",
    "subjectId": "<string>",
    "amountUsd": 123,
    "inputTokenLimit": 123,
    "outputTokenLimit": 123,
    "totalTokenLimit": 123,
    "spentUsd": 123,
    "usedTokens": 123,
    "effectiveAmountUsd": 123
  }
}

{
  "budget": {
    "id": "<string>",
    "budgetWindow": "daily",
    "state": "active",
    "metadata": {
      "memberLimitUsd": 500000000000,
      "memberLimitsUsd": {},
      "allowance": {
        "amountUsd": 500000000000,
        "windowStart": "2023-11-07T05:31:56Z"
      },
      "memberAllowances": {},
      "memberOfBudget": "<string>",
      "memberGroupId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accessProfileId": "<string>",
    "tokenId": "<string>",
    "subjectKind": "user",
    "subjectId": "<string>",
    "amountUsd": 123,
    "inputTokenLimit": 123,
    "outputTokenLimit": 123,
    "totalTokenLimit": 123,
    "spentUsd": 123,
    "usedTokens": 123,
    "effectiveAmountUsd": 123
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Guides

REST API

Update llm gateway budget

Authorizations

Headers

Path Parameters

Body

Response