कन्वर्ट 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 या डेटा URI जो 3D मॉडल फाइल की ओर इशारा करता है। समर्थित फॉर्मेट: .glb, .gltf, .obj, .fbx, .stl। डेटा URI के लिए, 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: निर्माण समय के अनुसार अवरोही क्रम में छांटें।

रिटर्न्स

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

अनुरोध

GET

/openapi/v1/convert

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

प्रतिक्रिया

[
  {
    "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

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

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

पैरामीटर्स

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

रिटर्न्स

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

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

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

progress · integer

टास्क की प्रगति (0-100)।

status · string

टास्क की स्थिति। संभावित मान: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED।

preceding_tasks · integer

पूर्ववर्ती टास्क की गिनती। केवल तब अर्थपूर्ण जब स्थिति PENDING हो।

created_at · टाइमस्टैंप

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

started_at · टाइमस्टैंप

जब टास्क शुरू किया गया था, उस समय का टाइमस्टैंप, मिलीसेकंड्स में। 0 अगर शुरू नहीं हुआ।

finished_at · टाइमस्टैंप

जब टास्क समाप्त हुआ था, उस समय का टाइमस्टैंप, मिलीसेकंड्स में। 0 अगर समाप्त नहीं हुआ।

task_error · object

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

consumed_credits · integer

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