मुख्य सामग्री पर जाएं
POST
खर्च नियम बनाएँ
spend_rules:write आवश्यक है। OAuth कॉलर का वर्कस्पेस का मालिक या एडमिन होना ज़रूरी है। हर राशि USD (*_usd) या नैनोडॉलर (*_nanos) में से किसी एक में भेजें, दोनों में नहीं। एक वर्कस्पेस में 50 खर्च नियम हो सकते हैं। मीट्रिक, आधार, दायरे और अवधियों के लिए खर्च अलर्ट गाइड देखें।

प्राधिकरण

Authorization
string
header
आवश्यक

Bearer टोकन से प्रमाणीकरण

बॉडी

application/json

बनाया जाने वाला खर्च नियम। name, metric और period ज़रूरी हैं। spike नियमों में डिफ़ॉल्ट रूप से 3x गुणक और $5 की न्यूनतम सीमा होती है।

name
string
आवश्यक
Required string length: 1 - 100
metric
enum<string>
आवश्यक

spend: खर्च threshold_amount तक पहुँचा। budget_percent: खर्च आधार के threshold_percents तक पहुँचा। forecast: अवधि के अंत तक अनुमानित खर्च सीमा तक पहुँचता है। spike: पिछले window_hours का खर्च पिछले 7 दिनों में उसी विंडो के माध्यिका (median) का कम से कम spike_multiplier गुना है, और कम से कम spike_floor। balance: वर्कस्पेस का बैलेंस या रनवे सीमा से नीचे जाता है।

उपलब्ध विकल्प:
spend,
budget_percent,
forecast,
spike,
balance
period
enum<string>
आवश्यक

नियम के समय क्षेत्र में day, week (सोमवार से) या month, या पिछले window_hours पर rolling।

उपलब्ध विकल्प:
day,
week,
month,
rolling
enabled
boolean
scope_type
enum<string>
उपलब्ध विकल्प:
workspace,
key,
member,
department,
model,
provider
scope_id
string | null

वर्कस्पेस दायरे के लिए null; अन्यथा कुंजी ID, सदस्य का उपयोगकर्ता ID, विभाग ID, मॉडल ID या प्रदाता ID।

Maximum string length: 200
window_hours
integer | null

rolling विंडो के घंटे: spike नियमों के लिए स्पाइक विंडो (अधिकतम 56, ताकि पिछले 7 दिनों में 3 विंडो आ सकें) और balance नियमों के लिए खर्च दर की अवधि। कैलेंडर अवधियों के लिए null।

आवश्यक सीमा: 1 <= x <= 720
time_zone
string | null

कैलेंडर अवधियों के लिए IANA समय क्षेत्र। null होने पर वर्कस्पेस का बिलिंग समय क्षेत्र इस्तेमाल होता है।

Maximum string length: 64
base_kind
enum<string> | null

threshold_percents किसके प्रतिशत हैं: amount (base_amount), workspace_budget या key_limit (base_ref अंतराल, जो अवधि से मेल खाना चाहिए), या previous_period।

उपलब्ध विकल्प:
amount,
workspace_budget,
key_limit,
previous_period
base_ref
enum<string> | null
उपलब्ध विकल्प:
daily,
weekly,
monthly
base_amount_usd
number | null
base_amount_nanos
integer<int64> | null
threshold_percents
integer[] | null

आधार के अधिकतम पाँच पूर्ण प्रतिशत, क्रम में। हर एक प्रति अवधि अधिकतम एक बार ट्रिगर होता है; एक साथ कई पार होने पर सबसे ऊँचे का नाम लेकर एक अलर्ट भेजा जाता है।

Required array length: 1 - 5 elements
आवश्यक सीमा: 1 <= x <= 1000
threshold_amount_usd
number | null
threshold_amount_nanos
integer<int64> | null
runway_days
integer | null
आवश्यक सीमा: 1 <= x <= 365
spike_multiplier
number | null
spike_floor_usd
number | null
spike_floor_nanos
integer<int64> | null
action
enum<string>

notify, या सूचना देकर फिर ब्लॉक करें जब खर्च आधार के block_at_percent या block_at_amount तक पहुँचे। ब्लॉक करना सर्वोत्तम प्रयास पर आधारित है और सीमा के कुछ मिनट बाद लागू होता है। जब तक गेटवे पर ब्लॉक करना बंद है, ब्लॉक करना शुरू करने वाला नियम 400 के साथ अस्वीकार किया जाता है, और पहले से ब्लॉक करने वाला नियम केवल सूचना देता है।

उपलब्ध विकल्प:
notify,
block
block_at_percent
integer
आवश्यक सीमा: 100 <= x <= 1000
block_at_amount_usd
number | null
block_at_amount_nanos
integer<int64> | null
block_free_models
boolean

क्या ब्लॉक मुफ़्त मॉडल के अनुरोध भी रोकता है।

cooldown_minutes
integer

rolling, spike और balance नियमों के लिए अलर्ट के बीच न्यूनतम मिनट।

आवश्यक सीमा: 5 <= x <= 43200
destination_ids
string<uuid>[]

इस नियम के अलर्ट के सूचना गंतव्य। खाली होने का मतलब वर्कस्पेस का Spend Alerts रूट है।

Maximum array length: 50

प्रतिक्रिया

खर्च नियम बनाया गया

data
object
आवश्यक

एक खर्च नियम: किसी दायरे और अवधि में डॉलर या प्रतिशत की सीमाएँ जो सूचना देती हैं, या सूचना देकर फिर ब्लॉक करती हैं। राशियाँ नैनोडॉलर और USD दोनों में लौटाई जाती हैं।

अंतिम संशोधन 31 अक्टूबर 2026