objectstack/packages/spec/json-schema/ai/BudgetLimit.json at 8ae3d928f9c95dd320e89d8629a52085fc3d2d73 · objectstack-ai/objectstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
{
  "$ref": "#/definitions/BudgetLimit",
  "definitions": {
    "BudgetLimit": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "global",
            "user",
            "agent",
            "object",
            "project",
            "department"
          ]
        },
        "scope": {
          "type": "string",
          "description": "Scope identifier (userId, agentId, etc.)"
        },
        "maxCost": {
          "type": "number",
          "minimum": 0,
          "description": "Maximum cost limit"
        },
        "currency": {
          "type": "string",
          "default": "USD"
        },
        "period": {
          "type": "string",
          "enum": [
            "hourly",
            "daily",
            "weekly",
            "monthly",
            "quarterly",
            "yearly",
            "custom"
          ]
        },
        "customPeriodDays": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "description": "Custom period in days"
        },
        "softLimit": {
          "type": "number",
          "minimum": 0,
          "description": "Soft limit for warnings"
        },
        "warnThresholds": {
          "type": "array",
          "items": {
            "type": "number",
            "minimum": 0,
            "maximum": 1
          },
          "description": "Warning thresholds (e.g., [0.5, 0.8, 0.95])"
        },
        "enforced": {
          "type": "boolean",
          "default": true,
          "description": "Block requests when exceeded"
        },
        "gracePeriodSeconds": {
          "type": "integer",
          "minimum": 0,
          "default": 0,
          "description": "Grace period after limit exceeded"
        },
        "allowRollover": {
          "type": "boolean",
          "default": false,
          "description": "Allow unused budget to rollover"
        },
        "maxRolloverPercentage": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Max rollover as % of limit"
        },
        "name": {
          "type": "string",
          "description": "Budget name"
        },
        "description": {
          "type": "string"
        },
        "active": {
          "type": "boolean",
          "default": true
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "type",
        "maxCost",
        "period"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}