POST/api/v1/cost/alerts

Create a cost alert rule

Configures a new alert: e.g., "alert when monthly OpenAI spend > $10k".

Authentication

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

Request body required

Example

{
  "metric": "monthly_total",
  "threshold_usd": 0,
  "scope": {}
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "threshold_usd",
        "metric"
      ],
      "properties": {
        "metric": {
          "type": "string",
          "enum": [
            "monthly_total",
            "daily_total",
            "per_provider",
            "per_project"
          ]
        },
        "threshold_usd": {
          "type": "number",
          "minimum": 0
        },
        "scope": {
          "type": "object"
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Alert created.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/cost/alerts \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "metric": "monthly_total", "threshold_usd": 0, "scope": {} }'

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/alerts",
  body: {
    "metric": "monthly_total",
    "threshold_usd": 0,
    "scope": {}
  },
});
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/alerts",
    body={
    "metric": "monthly_total",
    "threshold_usd": 0,
    "scope": {}
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/cost/alerts", map[string]any{"metric": "monthly_total", "threshold_usd": 0, "scope": map[string]any{}})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401403429

Other Cost & FinOps endpoints