Usage API

बिलिंग एक्सपोर्ट और लागत रिपोर्ट के लिए, अपनी टीम के पूर्ण हो चुके API टास्क और प्रत्येक द्वारा उपयोग किए गए क्रेडिट की सूची प्राप्त करें।

इस एंडपॉइंट को कॉल करने के लिए, किसी Studio या Enterprise टीम के सक्रिय सदस्य की API की का उपयोग करें। कोई भी सदस्य इसे कॉल कर सकता है, केवल owners और admins ही नहीं। किसी अन्य API की के साथ, रिक्वेस्ट 403 लौटाती है।

GET/openapi/v1/usage/tasks

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

यह आपकी टीम के उपयोग रिकॉर्ड का एक पेज लौटाता है, डिफ़ॉल्ट रूप से सबसे नया पहले। start_time और end_time के बिना, रिकॉर्ड पिछले 30 दिनों को कवर करते हैं। इस एंडपॉइंट को कॉल करना मुफ़्त है।

रिकॉर्ड में ये टास्क शामिल हैं:

API टास्क जो SUCCEEDED या FAILED के रूप में पूर्ण हुए
टीम के हर मौजूदा सदस्य के टास्क, उनकी किसी भी API की से
वे टास्क जिन्हें आपने डिलीट कर दिया है, और जिनकी फ़ाइलें एक्सपायर हो चुकी हैं

रिकॉर्ड में ये टास्क शामिल नहीं हैं:

वे टास्क जो अभी भी PENDING या IN_PROGRESS हैं, और CANCELED टास्क
टीम छोड़ चुके लोगों के टास्क
Creative Lab टास्क
वे टास्क जिन्हें Meshy के AI एजेंट्स ने चलाया
Meshy वेब ऐप में किया गया काम

कोई टास्क रिकॉर्ड में तभी दिखाई देता है जब वह पूर्ण हो जाता है, उसके created_at की विंडो में। Meshy टास्क बनाते समय क्रेडिट चार्ज करता है, इसलिए अभी भी चल रहा टास्क रिकॉर्ड में नहीं होता। क्रेडिट बैलेंस के साथ रिकॉर्ड का मिलान करने से पहले, हाल की विंडो को फिर से प्राप्त करें, या कुछ देर रुककर एक्सपोर्ट करें।

यदि आपकी टीम की डेटा रिटेंशन अवधि है, तो विंडो उस अवधि की अनुमति से पहले शुरू नहीं होती।

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",
    "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 और refine
- text-to-3d-preview: केवल preview टास्क
- text-to-3d-refine: केवल 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
- print-split
Name
status
Type
string
Description
शामिल किया जाने वाला स्टेटस, SUCCEEDED या FAILED। दोनों शामिल करने के लिए इसे छोड़ दें। कोई भी अन्य मान 400 लौटाता है।

रिटर्न

उपयोग रिकॉर्ड की एक array लौटाता है। कोई मिलान रिकॉर्ड न होने पर array खाली होती है।

विफलता के तरीके

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
टास्क ID, वही ID जो बनाने वाले एंडपॉइंट ने लौटाई थी। टास्क को, उसके आउटपुट URL सहित, प्राप्त करने के लिए, ID को उस एंडपॉइंट के 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 देखें।