Skip to content
POST/api/v1/cost/budget

Save cost budget or check a cost against budget

Default action saves a budget (requires monthlyLimit). With action='check' (requires estimatedCost), runs BudgetEnforcer.canProceed against current-month spend and returns the decision.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "action": "check",
  "estimatedCost": 0,
  "monthlyLimit": 0,
  "warningThreshold": 0,
  "criticalThreshold": 0,
  "mode": "soft"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "action": {
          "type": "string",
          "enum": [
            "check"
          ],
          "description": "When 'check', requires estimatedCost and returns a budget decision instead of saving. Omit to save a budget (requires monthlyLimit)."
        },
        "estimatedCost": {
          "type": "number",
          "minimum": 0,
          "description": "Required when action='check'."
        },
        "monthlyLimit": {
          "type": "number",
          "minimum": 0,
          "description": "Required when saving (action omitted)."
        },
        "warningThreshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "criticalThreshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "mode": {
          "type": "string",
          "enum": [
            "soft",
            "hard"
          ]
        }
      },
      "required": [
        "projectId"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Budget check decision (action='check').
201Budget saved.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/cost/budget \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "action": "check", "estimatedCost": 0, "monthlyLimit": 0, "warningThreshold": 0, "criticalThreshold": 0, "mode": "soft" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/cost/budget",
  body: {
    "projectId": "00000000-0000-0000-0000-000000000000",
    "action": "check",
    "estimatedCost": 0,
    "monthlyLimit": 0,
    "warningThreshold": 0,
    "criticalThreshold": 0,
    "mode": "soft"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/cost/budget",
    body={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "action": "check",
    "estimatedCost": 0,
    "monthlyLimit": 0,
    "warningThreshold": 0,
    "criticalThreshold": 0,
    "mode": "soft"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","action":"check","estimatedCost":0,"monthlyLimit":0,"warningThreshold":0,"criticalThreshold":0,"mode":"soft"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/cost/budget", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401429

Other Cost & FinOps endpoints