Sign in

v136

OpenAPI 3.1.0MITraw.githubusercontent.com2026-08-08967451.3 MB
Workspaces

Get a workspace budget

Retrieve the budget for a given interval. Management key required.

get/workspaces/{id}/budgets/{interval}

Path parameters

idstring required

The workspace ID (UUID) or slug

Example:production

The workspace ID (UUID) or slug

interval'daily' | 'weekly' | 'monthly' | 'lifetime' required

Budget reset interval. Use "lifetime" for a one-time budget that never resets.

Example:monthly

Budget reset interval. Use "lifetime" for a one-time budget that never resets.

Response

Budget retrieved successfully

include_byok_in_budgetsboolean

Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime).

Example response

{
  "data": {
    "created_at": "2025-08-24T10:30:00Z",
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "limit_usd": 100,
    "reset_interval": "monthly",
    "updated_at": "2025-08-24T15:45:00Z",
    "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "include_byok_in_budgets": true
}