Usage API

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

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

GET/openapi/v1/usage/tasks

List Usage Records

टीम के 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 एक अम्ब्रेला है जो preview और refine दोनों चरणों को कवर करता है। हर एंडपॉइंट शामिल करने के लिए इसे छोड़ दें।
Name
status
Type
string
Description
अंतिम टास्क स्टेटस के अनुसार फ़िल्टर करें: SUCCEEDED या FAILED। दोनों शामिल करने के लिए इसे छोड़ दें।

रिटर्न

The Usage Record Objects की एक पेजिनेटेड सूची लौटाता है।

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

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

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

The Usage Record Object

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