Usage API
बिलिंग एक्सपोर्ट और लागत रिपोर्ट के लिए अपनी टीम के पूर्ण हो चुके API कार्यों और हर एक में इस्तेमाल हुए क्रेडिट की सूची देखें।
इस एंडपॉइंट को कॉल करने के लिए, किसी Studio या Enterprise टीम के सक्रिय सदस्य की API की का उपयोग करें। कोई भी सदस्य इसे कॉल कर सकता है, न केवल मालिक और एडमिन। किसी अन्य API की के साथ, अनुरोध 403 लौटाता है।
उपयोग रिकॉर्ड की सूची
यह आपकी टीम के उपयोग रिकॉर्ड का एक पेज लौटाता है, डिफ़ॉल्ट रूप से नवीनतम सबसे पहले। start_time और end_time के बिना, रिकॉर्ड पिछले 30 दिनों को कवर करते हैं। इस एंडपॉइंट को कॉल करना निःशुल्क है।
रिकॉर्ड में ये कार्य शामिल हैं:
- API कार्य जो
SUCCEEDEDयाFAILEDके रूप में समाप्त हुए - टीम के हर वर्तमान सदस्य के कार्य, उनकी किसी भी API की से
- कार्य जिन्हें आपने हटा दिया, और वे कार्य जिनकी फ़ाइलें समाप्त हो चुकी हैं
रिकॉर्ड में ये कार्य शामिल नहीं हैं:
- ऐसे कार्य जो अभी भी
PENDINGयाIN_PROGRESSहैं, औरCANCELEDकार्य - उन लोगों के कार्य जो टीम छोड़ चुके हैं
- Creative Lab के कार्य
- कार्य जिन्हें Meshy के AI एजेंट्स ने चलाया
- Meshy वेब ऐप में किया गया काम
कोई कार्य रिकॉर्ड में केवल उसके समाप्त होने के बाद दिखाई देता है, उसके created_at की विंडो में। Meshy किसी कार्य को बनाते समय क्रेडिट चार्ज करता है, इसलिए कोई कार्य जो अभी भी चल रहा है, रिकॉर्ड से गायब होता है। रिकॉर्ड को अपने क्रेडिट बैलेंस के साथ मिलाने से पहले, हाल की विंडो को फिर से खींचें, या थोड़ी देरी के बाद एक्सपोर्ट करें।
यदि आपकी टीम के पास डेटा रिटेंशन अवधि है, तो विंडो उस अवधि से पहले शुरू नहीं होती जितनी वह अनुमति देती है।
Request
curl "https://api.meshy.ai/openapi/v1/usage/tasks?page_size=50&start_time=2026-08-01T00:00:00Z&end_time=2026-09-01T00:00:00Z" \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"endpoint": "image-to-3d",
"status": "SUCCEEDED",
"created_at": 1755787000000,
"finished_at": 1755787045000,
"consumed_credits": 20,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {
"user": "alex@example.com",
"team": "fab"
}
},
{
"task_id": "018a210d-1c22-7e0f-9d3a-4a5b6c7d8e9f",
"endpoint": "text-to-3d-refine",
"status": "FAILED",
"created_at": 1755786000000,
"finished_at": 1755786030000,
"consumed_credits": 0,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {}
}
]
पैरामीटर
- Name
- page_num
- Type
- integer
- डिफ़ॉल्ट 1
- Description
लौटाया जाने वाला पेज,
1से255तक।255से ऊपर का मान400लौटाता है। एक विंडो में अधिकतम 255 पेज होते हैं, इसलिए एक बड़े एक्सपोर्ट को छोटी विंडो में विभाजित करें।
- Name
- page_size
- Type
- integer
- डिफ़ॉल्ट 10
- Description
प्रति पेज रिकॉर्ड की संख्या,
1से100तक।101से255तक का मान 100 रिकॉर्ड लौटाता है, और255से ऊपर का मान400लौटाता है।
- Name
- sort_by
- Type
- string
- डिफ़ॉल्ट -created_at
- Description
सॉर्ट क्रम।
उपलब्ध मान:
+created_at: सबसे पुराना पहले-created_at: सबसे नया पहले
URL में,
+को%2Bके रूप में लिखें। अन्यथा+को स्पेस के रूप में पढ़ा जाता है, और अनुरोध400लौटाता है।
- Name
- start_time
- Type
- string
- Description
विंडो की शुरुआत, RFC 3339 टाइमस्टैंप के रूप में, उदाहरण के लिए
2026-08-01T00:00:00Z। रिकॉर्ड में इस समय या उसके बाद बनाए गए कार्य शामिल हैं। विंडो कोend_timeसे 30 दिन पहले शुरू करने के लिए इसे छोड़ दें।विंडो अधिकतम 366 दिनों तक फैल सकती है। इससे लंबी विंडो
400लौटाती है, इसलिए लंबे एक्सपोर्ट को कई विंडो में विभाजित करें।
- Name
- end_time
- Type
- string
- Description
विंडो का अंत, RFC 3339 टाइमस्टैंप के रूप में। रिकॉर्ड में इस समय से पहले बनाए गए कार्य शामिल हैं। विंडो को आपके अनुरोध के समय समाप्त करने के लिए इसे छोड़ दें।
- Name
- endpoints
- Type
- string
- Description
शामिल किए जाने वाले एंडपॉइंट की अल्पविराम-सीमांकित सूची,
endpointफ़ील्ड के समान नामों से। हर एंडपॉइंट को शामिल करने के लिए इसे छोड़ दें। एक अज्ञात नाम400लौटाता है।उपलब्ध मान:
text-to-3d: हर टेक्स्ट से 3D कार्य, preview और refinetext-to-3d-preview: केवल preview कार्यtext-to-3d-refine: केवल refine कार्यimage-to-3dmulti-image-to-3dretextureremeshconvertresizeuv-unwrapriganimatetext-to-motiontext-to-imageimage-to-imageprint-multi-colorprint-repairprint-analyzeprint-splitrelief
- Name
- status
- Type
- string
- Description
शामिल करने के लिए स्थिति,
SUCCEEDEDयाFAILED। दोनों को शामिल करने के लिए इसे छोड़ दें। कोई अन्य मान400लौटाता है।
रिटर्न
उपयोग रिकॉर्ड का एक ऐरे लौटाता है। जब कोई रिकॉर्ड मेल नहीं खाता तो ऐरे खाली होता है।
विफलता के तरीके
- Name
400 - Bad Request- Description
कोई पैरामीटर अमान्य है, और त्रुटि संदेश बताता है कि कौन सा। पैरामीटर को ठीक करें, फिर अनुरोध फिर से भेजें।
- Name
401 - Unauthorized- Description
API की गायब है या अमान्य है।
Authorizationहेडर जांचें।
- Name
403 - Forbidden- Description
API की का खाता किसी Studio या Enterprise टीम का सक्रिय सदस्य नहीं है। संदेश है
This endpoint is available on Studio and Enterprise plans। किसी Studio या Enterprise टीम सदस्य की API की का उपयोग करें।
- Name
429 - Too Many Requests- Description
आपने बहुत अधिक अनुरोध भेजे।
Retry-Afterमें दिए गए सेकंड की संख्या प्रतीक्षा करें, फिर पुनः प्रयास करें।
उपयोग रिकॉर्ड ऑब्जेक्ट
Example usage record object
{
"task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"endpoint": "image-to-3d",
"status": "SUCCEEDED",
"created_at": 1755787000000,
"finished_at": 1755787045000,
"consumed_credits": 20,
"api_key_name": "production",
"api_key_suffix": "a1b2",
"metadata": {
"user": "alex@example.com",
"team": "fab"
}
}
- Name
- task_id
- Type
- string
- Description
कार्य आईडी, वही आईडी जो बनाने वाले एंडपॉइंट ने लौटाई थी। कार्य को ही, उसके आउटपुट URL के साथ पाने के लिए, उस आईडी को उस एंडपॉइंट के get रूट पर भेजें, उदाहरण के लिए एक
image-to-3dरिकॉर्ड के लिएGET /openapi/v1/image-to-3d/{task_id}।
- Name
- endpoint
- Type
- string
- Description
वह एंडपॉइंट जिस पर कार्य चला, उदाहरण के लिए
image-to-3dयाrig। एक टेक्स्ट से 3D कार्य अपना चरण दिखाता है,text-to-3d-previewयाtext-to-3d-refine।पुराने रिकॉर्ड में सेवानिवृत्त एंडपॉइंट के नाम हो सकते हैं, जिन्हें
endpointsफ़िल्टर स्वीकार नहीं करता।
- Name
- status
- Type
- string
- Description
कार्य की अंतिम स्थिति,
SUCCEEDEDयाFAILED।
- Name
- created_at
- Type
- timestamp
- Description
कार्य बनाए जाने का समय, Unix मिलीसेकंड में।
- Name
- finished_at
- Type
- timestamp
- Description
कार्य समाप्त होने का समय, Unix मिलीसेकंड में। यदि कार्य का कोई समाप्ति समय नहीं है तो
null।
- Name
- consumed_credits
- Type
- integer
- Description
कार्य द्वारा उपयोग किए गए क्रेडिट की संख्या, रिफंड के बाद। किसी विफल कार्य के लिए
0, क्योंकि Meshy इसे रिफंड करता है, और किसी निःशुल्क कार्य, जैसे प्रिंट-योग्यता विश्लेषण के लिए भी।
- Name
- api_key_name
- Type
- string
- Description
उस API की का नाम जिसने कार्य चलाया। किसी ऐप लॉगिन से चलाए गए कार्य के लिए, यह ऐप का नाम है, उदाहरण के लिए
Meshy CLI।यह कुछ मामलों में खाली स्ट्रिंग होती है, उदाहरण के लिए:
- कार्य के लिए कभी चार्ज नहीं किया गया, जैसे प्रिंट-योग्यता विश्लेषण कार्य, जो निःशुल्क है।
- API की हटाई जा चुकी है।
- API की पिछले कुछ मिनटों में बनाई गई थी।
- Name
- api_key_suffix
- Type
- string
- Description
उस API की के अंतिम चार अक्षर, समान नाम वाली कुंजियों में अंतर बताने के लिए। जब भी
api_key_nameखाली हो, और Meshy CLI जैसे ऐप लॉगिन के लिए, एक खाली स्ट्रिंग।
- Name
- metadata
- Type
- object
- Description
कार्य बनाए जाने के समय
X-Meshy-Metadataहेडर में भेजे गए टैग। यदि कोई नहीं है तो{}। Metadata देखें।