Balance API

Balance API आपको अपने अकाउंट के लिए मौजूदा क्रेडिट बैलेंस प्राप्त करने की सुविधा देता है। यह एंडपॉइंट आपके उपलब्ध क्रेडिट की जांच करने का एक सरल तरीका प्रदान करता है, जिनका उपयोग विभिन्न Meshy सेवाओं के लिए किया जाता है।

GET/openapi/v1/balance

Get Balance

यह एंडपॉइंट प्रमाणित यूज़र के लिए मौजूदा क्रेडिट बैलेंस प्राप्त करता है।

रिटर्न वैल्यू

मौजूदा क्रेडिट बैलेंस वाला एक ऑब्जेक्ट रिटर्न करता है। टीम सदस्यों के लिए, ये वैल्यू टीम के शेयर्ड क्रेडिट पूल को दर्शाती हैं।

Name
balance
Type
integer
Description
आपके अकाउंट में वर्तमान में उपलब्ध क्रेडिट की संख्या।
Name
monthly_credits
Type
integer
Description
शेष क्रेडिट की संख्या जो अगले मासिक रिफ्रेश पर समाप्त हो जाती है, जैसा कि monthly_resets_at में बताया गया है।
Name
permanent_credits
Type
integer
Description
वे क्रेडिट जो कभी समाप्त नहीं होते, जैसे खरीदे गए क्रेडिट पैक या अर्जित रिवॉर्ड से मिले क्रेडिट।
Name
monthly_resets_at
Type
timestamp
Description
अगले मासिक क्रेडिट रिफ्रेश का समय, जिसे मिलीसेकंड में Unix टाइमस्टैंप के रूप में दर्शाया गया है। इस समय, मौजूदा मासिक क्रेडिट समाप्त हो जाते हैं और फिर से भर दिए जाते हैं, बशर्ते सब्सक्रिप्शन सक्रिय हो। यदि कोई रिफ्रेश शेड्यूल नहीं है तो null रिटर्न करता है।

सामान्यतः, balance, monthly_credits + permanent_credits के बराबर होता है। यदि कॉलर पर किसी सदस्य या वर्कस्पेस क्रेडिट लिमिट लागू होती है, तो balance कम हो सकता है।

Request

GET

/openapi/v1/balance

curl https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "balance": 1000,
  "monthly_credits": 600,
  "permanent_credits": 400,
  "monthly_resets_at": 1793491200000
}