ai-gateway

List AI Gateway budgets

Changed on

List the team's AI Gateway budgets (team/project/user scopes, plus default-covered api-key spend) as a flat list, optionally filtered by scope. Without limit or cursor, returns every budget. With either, returns one page ordered by quotaEntityId plus nextCursor (null on the last page) and defaultCoveredCounts. Paging still reads the full merge server-side: the gateway meter list it joins has no cursor.

get/ai-gateway/budgets/list

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/ai-gateway/budgets/list
  • Auth: HTTP bearer

Query parameters

scopeType'team' | 'project' | 'user' | 'api-key'

Restrict the list to a single budget scope.

includeDefaultCovered'true' | 'false'

Whether to include rows inherited from a budget default (source: "default"). Defaults to true.

limitinteger

Maximum number of budgets to return (capped at 200). Enables pagination.

cursorstring

Opaque cursor returned by a prior call as nextCursor.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

nextCursorstring nullable

Paged requests only (limit or cursor set): pass as cursor to read the next page; null on the last page.

Changes

  • 8939e3983223Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter includeDefaultCovered

    • info

      added the new optional query request parameter limit

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6f68095b42b1Revision changes
    • info

      endpoint added