कन्वर्ट API

कन्वर्ट API आपको मौजूदा 3D मॉडल्स को अलग-अलग फ़ाइल फ़ॉर्मैट में कन्वर्ट करने की अनुमति देता है।

POST/openapi/v1/convert

कन्वर्ट कार्य बनाएँ

यह एंडपॉइंट एक नया फ़ॉर्मेट रूपांतरण कार्य बनाता है।

पैरामीटर

input_task_id या model_url में से केवल एक आवश्यक है। यदि दोनों दिए गए हैं, तो input_task_id को प्राथमिकता मिलती है।

Name
input_task_id
Type
string
आवश्यक
Description
एक पूर्ण Meshy कार्य की ID, जिसका मॉडल आप कन्वर्ट करना चाहते हैं। कार्य की स्थिति SUCCEEDED होनी चाहिए।

Name
model_url
Type
string
आवश्यक
Description
एक सार्वजनिक रूप से सुलभ URL या Data URI जो किसी 3D मॉडल फ़ाइल की ओर संकेत करता है। समर्थित फ़ॉर्मेट: .glb, .gltf, .obj, .fbx, .stl। Data URIs के लिए, MIME type का उपयोग करें: application/octet-stream।

Name
target_formats
Type
string[]
आवश्यक
Description
कन्वर्ट किए गए मॉडल के लिए आउटपुट फ़ॉर्मेट की सूची। उपलब्ध मान: glb, fbx, obj, usdz, blend, stl, 3mf।

रिटर्न

प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए कन्वर्ट कार्य की id होती है।

विफलता मोड

400 - Bad Request

अनुरोध स्वीकार्य नहीं था। सामान्य कारण:

गुम पैरामीटर: model_url या input_task_id में से कोई एक प्रदान किया जाना चाहिए।
गुम target_formats: कम से कम एक लक्ष्य फ़ॉर्मेट निर्दिष्ट किया जाना चाहिए।
अमान्य इनपुट कार्य: input_task_id को किसी सफल कार्य का संदर्भ देना चाहिए।
अमान्य मॉडल फ़ॉर्मेट: model_url किसी असमर्थित एक्सटेंशन वाली फ़ाइल की ओर संकेत करता है।
पहुंच से बाहर URL: model_url डाउनलोड नहीं किया जा सका।

401 - Unauthorized

प्रमाणीकरण विफल रहा। कृपया अपनी API की जांचें।

402 - Payment Required

इस कार्य को करने के लिए अपर्याप्त क्रेडिट।

429 - Too Many Requests

आपने अपनी रेट लिमिट पार कर ली है।

Request

POST

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/convert/:id

कन्वर्ट टास्क प्राप्त करें

यह एंडपॉइंट उसके ID द्वारा एक कन्वर्ट टास्क प्राप्त करता है।

पैरामीटर

Name
id
Type
path
Description
प्राप्त करने के लिए कन्वर्ट टास्क की ID।

रिटर्न

कन्वर्ट टास्क ऑब्जेक्ट।

Request

GET

/openapi/v1/convert/:id

curl https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
      "glb": "",
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "obj": "",
      "usdz": "",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

DELETE/openapi/v1/convert/:id

कन्वर्ट टास्क हटाएँ

यह एंडपॉइंट सभी संबद्ध मॉडल और डेटा सहित एक कन्वर्ट टास्क को स्थायी रूप से हटाता है। यह कार्रवाई अपरिवर्तनीय है।

पाथ पैरामीटर

Name
id
Type
path
Description
हटाए जाने वाले कन्वर्ट टास्क की ID।

रिटर्न

सफलता पर 200 OK रिटर्न करता है।

Request

DELETE

/openapi/v1/convert/:id

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/convert

कन्वर्ट कार्यों की सूची

यह एंडपॉइंट आपको कन्वर्ट कार्यों की सूची प्राप्त करने की अनुमति देता है।

पैरामीटर

Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
पेजिनेशन के लिए पेज संख्या।

Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
पेज आकार सीमा। अधिकतम अनुमत 50 आइटम हैं।

Name
sort_by
Type
string
Description
सॉर्ट करने के लिए फ़ील्ड। उपलब्ध मान:
- +created_at: निर्माण समय के अनुसार आरोही क्रम में सॉर्ट करें।
- -created_at: निर्माण समय के अनुसार अवरोही क्रम में सॉर्ट करें।

रिटर्न

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

Request

GET

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "convert",
    "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]

GET/openapi/v1/convert/:id/stream

कन्वर्ट टास्क स्ट्रीम करें

यह एंडपॉइंट Server-Sent Events (SSE) का उपयोग करके कन्वर्ट टास्क के लिए रियल-टाइम अपडेट स्ट्रीम करता है।

पैरामीटर

Name
id
Type
path
Description
स्ट्रीम किए जाने वाले कन्वर्ट टास्क का विशिष्ट पहचानकर्ता।

रिटर्न

Server-Sent Events के रूप में कन्वर्ट टास्क ऑब्जेक्ट्स की एक स्ट्रीम लौटाता है।

PENDING या IN_PROGRESS टास्क के लिए, प्रतिक्रिया स्ट्रीम में केवल आवश्यक progress और status फ़ील्ड शामिल होंगे।

Request

GET

/openapi/v1/convert/:id/stream

curl -N https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
    "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
    "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

कन्वर्ट टास्क ऑब्जेक्ट

कन्वर्ट टास्क ऑब्जेक्ट एक फ़ॉर्मैट कन्वर्ज़न जॉब का प्रतिनिधित्व करता है।

प्रॉपर्टीज़

id · string

टास्क के लिए यूनिक आइडेंटिफ़ायर।

type · string

टास्क का टाइप। वैल्यू convert है।

model_urls · object

कन्वर्ट की गई मॉडल फ़ाइलों के लिए डाउनलोड किए जा सकने वाले URL। केवल target_formats में निर्दिष्ट फ़ॉर्मैट के URL होंगे। अन्य फ़ॉर्मैट प्रॉपर्टीज़ खाली स्ट्रिंग होंगी।

progress · integer

टास्क का progress (0-100)।

status · string

टास्क का स्टेटस। संभावित वैल्यू: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED।

preceding_tasks · integer

पिछले टास्क की संख्या। केवल तब अर्थपूर्ण जब स्टेटस PENDING हो।

created_at · timestamp

टास्क बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।

started_at · timestamp

टास्क शुरू होने का टाइमस्टैंप, मिलीसेकंड में। शुरू न होने पर 0।

finished_at · timestamp

टास्क समाप्त होने का टाइमस्टैंप, मिलीसेकंड में। समाप्त न होने पर 0।

task_error · object

यदि टास्क विफल हुआ हो तो एरर ऑब्जेक्ट। अधिक विवरण के लिए एरर देखें।

consumed_credits · integer

इस टास्क द्वारा खपत किए गए क्रेडिट की संख्या (प्रति कन्वर्ट टास्क 1 क्रेडिट)। FAILED टास्क के लिए 0 लौटाता है।