Skip to content
Docs

Upsert AI Gateway budget default

PUThttps://api.vercel.com/ai-gateway/budgets/defaults
Create or update an AI Gateway budget default for one scope. Team-level authority only (owners/admins).
https://api.vercel.com/ai-gateway/budgets/defaults
const response = await fetch('https://api.vercel.com/ai-gateway/budgets/defaults?teamId=string&slug=string', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "scopeType": "team",
    "limitAmount": "123",
    "refreshPeriod": "daily",
    "alertThresholds": []
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "active": "false",
  "alertThresholds": [],
  "createdAt": "123",
  "limitAmount": "123",
  "refreshPeriod": "daily",
  "scopeType": "api-key",
  "updatedAt": "123"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Body

application/json
scopeTypestringRequired
limitAmountnumberRequired
Default budget limit in dollars.
refreshPeriodstringOptional
alertThresholdsarrayOptional

Response

200Success
activebooleanRequired
alertThresholdsarrayOptional
createdAtnumberRequired
limitAmountnumberRequired
refreshPeriodstringRequired
scopeTypestringRequired
updatedAtnumberRequired

Errors

400One of the provided values in the request body is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error
500Error