Get budget

Takes a project key or an organization key; requires gatewayBudgets:view at the key’s project, or at the organization for a key that names no project.

GET /api/gateway/v1/budgets/{id}

Get budget

Python

import requests

url = "https://app.langwatch.ai/api/gateway/v1/budgets/{id}"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "budget": {
    "id": "<string>",
    "organization_id": "<string>",
    "scope_type": "organization",
    "scope_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "window": "minute",
    "on_breach": "block",
    "limit_usd": "<string>",
    "limit_nano_usd": 0,
    "spent_usd": "<string>",
    "spent_nano_usd": 0,
    "timezone": "<string>",
    "provider_key": "<string>",
    "external_id": "<string>",
    "metadata": {},
    "current_period_started_at": "<string>",
    "resets_at": "<string>",
    "cycle_anchor_at": "<string>",
    "last_reset_at": "<string>",
    "archived_at": "<string>",
    "created_at": "<string>",
    "member_count": 0,
    "end_users_seen": 0,
    "end_users_over": 0,
    "scope_reach": "reachable"
  },
  "spend_available": true
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

id · string · required

Minimum string length: 1

Response

200

application/json

Success

budget · object · required

Show child attributes

spend_available · boolean · required