उपयोग API

उपयोग API आपकी टीम के ऐतिहासिक API टास्क को उनके द्वारा उपभोग किए गए क्रेडिट के साथ लौटाता है। समय सीमा, एंडपॉइंट, या स्थिति के आधार पर फ़िल्टर करें, और थोक में एक्सपोर्ट करने के लिए परिणामों में पेज दर पेज नेविगेट करें।

उपलब्धता। API की Studio या Enterprise टीम की होनी चाहिए; किसी अन्य प्लान की, या बिना टीम वाली, की पर 403 प्राप्त होता है।

GET/openapi/v1/usage/tasks

उपयोग रिकॉर्ड की सूची

यह टीम के API टास्क का एक पेज लौटाता है, सबसे नया पहले। बिना किसी स्पष्ट समय सीमा के, प्रतिक्रिया पिछले 30 दिनों को कवर करती है।

पैरामीटर

Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
पेजिनेशन के लिए पेज नंबर।
Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
पेज साइज़ सीमा। अधिकतम अनुमत 100 आइटम हैं।
Name
sort_by
Type
string
डिफ़ॉल्ट -created_at
Description
जिस फ़ील्ड के अनुसार क्रमबद्ध करना है।
उपलब्ध मान:
- +created_at: निर्माण समय के अनुसार आरोही क्रम में क्रमबद्ध करें।
- -created_at: निर्माण समय के अनुसार अवरोही क्रम में क्रमबद्ध करें।
Name
start_time
Type
string
Description
created_at सीमा की शुरुआत, RFC 3339 टाइमस्टैंप के रूप में (उदाहरण: 2026-08-01T00:00:00Z)। डिफ़ॉल्ट रूप से end_time से 30 दिन पहले। यह सीमा अधिकतम 1 वर्ष तक की हो सकती है — बड़े एक्सपोर्ट के लिए, लगातार सीमाओं के माध्यम से पेज करें।
Name
end_time
Type
string
Description
created_at सीमा का अंत, RFC 3339 टाइमस्टैंप के रूप में। डिफ़ॉल्ट रूप से वर्तमान समय।
Name
endpoints
Type
string
Description
शामिल किए जाने वाले एंडपॉइंट नामों की अल्पविराम से अलग की गई सूची। यह वही मान स्वीकार करता है जो endpoint प्रतिक्रिया फ़ील्ड में होते हैं — text-to-3d, text-to-3d-preview, text-to-3d-refine, image-to-3d, multi-image-to-3d, retexture, remesh, convert, resize, uv-unwrap, rig, animate, text-to-motion, text-to-image, image-to-image, print-multi-color, print-repair, print-analyze — जहां text-to-3d एक व्यापक श्रेणी है जो प्रीव्यू और रिफाइन दोनों चरणों को कवर करती है। हर एंडपॉइंट को शामिल करने के लिए इसे छोड़ दें।
Name
status
Type
string
Description
अंतिम टास्क स्थिति के अनुसार फ़िल्टर करें: SUCCEEDED या FAILED। दोनों को शामिल करने के लिए इसे छोड़ दें।

रिटर्न

उपयोग रिकॉर्ड ऑब्जेक्ट्स की एक पेजिनेटेड सूची लौटाता है।

रिकॉर्ड उन टास्क को कवर करते हैं जो अंतिम स्थिति तक पहुंच चुके हैं। टास्क बनाए जाने पर क्रेडिट चार्ज किए जाते हैं, इसलिए जब आप एक्सपोर्ट करते हैं तब भी चल रहा कोई टास्क उस सीमा के परिणामों में अभी तक शामिल नहीं होता — यदि आपके कुल योग को आपके क्रेडिट बैलेंस से बिल्कुल मेल खाना चाहिए तो हाल की सीमाओं को फिर से खींचें (या थोड़ी देरी के साथ एक्सपोर्ट करें)।

कस्टम डेटा-रिटेंशन नीति वाली टीमों को उनकी कॉन्फ़िगर की गई रिटेंशन विंडो के भीतर रिकॉर्ड प्राप्त होते हैं।

Request

GET

/openapi/v1/usage/tasks

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"
  },
  {
    "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"
  }
]

उपयोग रिकॉर्ड ऑब्जेक्ट

Name
task_id
Type
string
Description
उस टास्क की ID जिसके लिए यह रिकॉर्ड बिल किया गया — वही ID जो बनाने वाले एंडपॉइंट ने लौटाई थी। टास्क को स्वयं प्राप्त करने के लिए (इसके आउटपुट मॉडल या इमेज URL सहित, जो हर बार पढ़ने पर फिर से साइन किए जाते हैं), इसे संबंधित रिट्रीव एंडपॉइंट को पास करें, उदाहरण के लिए GET /openapi/v1/{endpoint}/{task_id}।
Name
endpoint
Type
string
Description
वह एंडपॉइंट जिस पर टास्क चला, उदाहरण के लिए image-to-3d या text-to-3d-refine। टेक्स्ट से 3D टास्क अपने चरण की रिपोर्ट करते हैं (text-to-3d-preview / text-to-3d-refine)।
Name
status
Type
string
Description
अंतिम टास्क स्थिति: SUCCEEDED या FAILED।
Name
created_at
Type
timestamp
Description
टास्क निर्माण का टाइमस्टैंप, मिलीसेकंड में।
Name
finished_at
Type
timestamp
Description
पूर्णता का टाइमस्टैंप, मिलीसेकंड में। यदि टास्क में पूर्णता का समय नहीं है तो null।
Name
consumed_credits
Type
integer
Description
इस टास्क द्वारा उपभोग किए गए क्रेडिट। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।
Name
api_key_name
Type
string
Description
जिस API की ने टास्क चलाया, उसका प्रदर्शन नाम। रद्द की गई की के लिए भी यह भरा रहता है, ताकि की रोटेशन के बाद भी ऐतिहासिक खर्च का श्रेय दिया जा सके।
Name
api_key_suffix
Type
string
Description
उस API की के अंतिम चार वर्ण, समान नाम वाली की को अलग पहचानने के लिए।

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"
}