Usage API

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

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

GET/openapi/v1/usage/tasks

List Usage Records

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

Parameters

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

Returns

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