कन्वर्ट API

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

POST/openapi/v1/convert

Convert Task बनाएं

यह एंडपॉइंट एक नया फॉर्मेट कन्वर्जन टास्क बनाता है।

पैरामीटर

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 प्रॉपर्टी में नए बनाए गए convert टास्क का 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

Convert टास्क प्राप्त करें

यह एंडपॉइंट किसी convert टास्क को उसकी ID के आधार पर प्राप्त करता है।

पैरामीटर

  • Name
    id
    Type
    path
    Description

    प्राप्त किए जाने वाले convert टास्क की ID।

रिटर्न

Convert Task ऑब्जेक्ट।

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।

टास्क स्टेटस

जो टास्क अभी भी PENDING है, उसे डिलीट कर दिया जाता है और बनाते समय खर्च हुए क्रेडिट रिफंड कर दिए जाते हैं।

जो टास्क पहले से ही IN_PROGRESS है, उसे डिलीट नहीं किया जा सकता: अनुरोध 409 Conflict के साथ अस्वीकार कर दिया जाता है और टास्क चलता रहता है। जिस टास्क को वर्कर पहले ही शुरू कर चुका है, उसके क्रेडिट रिफंड योग्य नहीं होते, इसलिए इसे बीच में डिलीट करने पर आपको क्रेडिट और परिणाम दोनों गंवाने पड़ेंगे। इसके SUCCEEDED, FAILED या CANCELED तक पहुँचने का इंतज़ार करें, फिर इसे डिलीट करें।

टर्मिनल स्थिति (SUCCEEDED, FAILED या CANCELED) में मौजूद टास्क बिना रिफंड के डिलीट कर दिया जाता है।

रिटर्न्स

सफल होने पर 200 OK लौटाता है, या जब टास्क IN_PROGRESS हो तो 409 Conflict लौटाता है।

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}
GET/openapi/v1/convert

Convert Tasks की सूची प्राप्त करें

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

Parameters

  • Name
    page_num
    Type
    integer
    डिफ़ॉल्ट 1
    Description

    पेजिनेशन के लिए पेज नंबर।

  • Name
    page_size
    Type
    integer
    डिफ़ॉल्ट 10
    Description

    पेज साइज़ सीमा। अधिकतम अनुमत 100 आइटम हैं।

  • Name
    sort_by
    Type
    string
    Description

    जिस फ़ील्ड के आधार पर सॉर्ट करना है। उपलब्ध मान:

    • +created_at: निर्माण समय के अनुसार आरोही क्रम में सॉर्ट करें।
    • -created_at: निर्माण समय के अनुसार अवरोही क्रम में सॉर्ट करें।

Returns

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

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

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

रिटर्न्स

The Convert Task Objects की एक स्ट्रीम 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
}

The Convert Task Object

Convert Task ऑब्जेक्ट एक फॉर्मेट कन्वर्जन जॉब को दर्शाता है।

Properties

  • id · string

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

  • type · string

टास्क का प्रकार। मान convert है।

  • model_urls · object

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

  • progress · integer

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

  • status · string

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

  • preceding_tasks · integer

पहले से मौजूद (preceding) टास्कों की संख्या। यह केवल तभी सार्थक है जब स्थिति PENDING हो।

  • created_at · timestamp

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

  • started_at · timestamp

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

  • finished_at · timestamp

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

  • task_error · object

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

  • consumed_credits · integer

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