टेक्स्ट से 3D API

टेक्स्ट से 3D API एक विशेषता है जो आपको Meshy की टेक्स्ट से 3D क्षमता को अपने एप्लिकेशन में एकीकृत करने की अनुमति देती है। इस खंड में आपको इस API से आरंभ करने के लिए आवश्यक सभी जानकारी मिलेगी।

टेक्स्ट से 3D दो-चरणीय वर्कफ़्लो का उपयोग करता है। सबसे पहले, एक प्रीव्यू टास्क (mode: "preview") बनाएं ताकि 3D मेश को बिना टेक्सचर के जनरेट किया जा सके, जिससे आप आकृति का मूल्यांकन कर सकें। फिर, पूर्ण प्रीव्यू के टास्क आईडी को एक रिफाइन टास्क (mode: "refine") में दिया जाता है ताकि मेश पर टेक्सचर लगाया जा सके। दोनों चरणों में एक ही एंडपॉइंट का उपयोग किया जाता है।

POST/openapi/v2/text-to-3d

एक टेक्स्ट से 3D प्रीव्यू टास्क बनाएं

यह एंडपॉइंट एक टेक्स्ट से 3D प्रीव्यू टास्क बनाता है, जो एक टेक्स्ट prompt से बिना टेक्सचर वाली 3D मेश (केवल ज्यामिति) जनरेट करता है। यह दो-चरणीय वर्कफ़्लो का पहला चरण है। एक बार प्रीव्यू सफल होने के बाद, टेक्सचरिंग के लिए लौटाए गए टास्क आईडी का उपयोग करें। पूर्ण प्रतिक्रिया स्कीमा के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट को देखें।

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
जब एक प्रीव्यू टास्क बनाते हैं तो इस फील्ड को "preview" पर सेट किया जाना चाहिए।
Name
prompt
Type
string
आवश्यक
Description
यह वर्णित करें कि 3D मॉडल कैसा ऑब्जेक्ट है। अधिकतम 600 वर्ण।
Name
model_type
Type
string
डिफ़ॉल्ट standard
Description
3D मेश जनरेशन के प्रकार को निर्दिष्ट करें।
उपलब्ध मूल्य:
- standard: नियमित उच्च-विस्तार 3D मेश जनरेशन।
- smart-topology: ai_model (meshy-t2) के साथ Smart Topology मॉडल चुनें।
- lowpoly (डेप्रिकेटेड): क्लीनर बहुभुजों के लिए ऑप्टिमाइज़्ड लो-पॉली मेश जनरेट करता है। smart-topology का उपयोग करने की अनुशंसा की जाती है।
जब smart-topology चुना जाता है, should_remesh और decimation_mode अनदेखे किए जाते हैं, और केवल topology: triangle स्वीकार्य है।
जब lowpoly चुना जाता है, ai_model, topology, target_polycount, और should_remesh अनदेखे किए जाते हैं।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
उपयोग करने के लिए मॉडल का आईडी। उपलब्ध मूल्यों को model_type पर निर्भर करेगा।
मानक जनरेशन (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Smart Topology जनरेशन (model_type: smart-topology):
- meshy-t2 (default): Smart Topology मॉडल — क्लीनर topology, मूल रूप से विभाजित भाग, त्रिकोण आउटपुट, और एक चेहरा संख्या जिसे आप target_polycount के साथ सेट कर सकते हैं।
Name
ultra_mode
Type
boolean
डिफ़ॉल्ट false
Description
उच्च-विश्वसनीयता ज्यामिति के लिए अल्ट्रा जनरेशन को सक्षम करता है जिसमें अधिक फाइनर सतह विवरण होते हैं। जनरेशन अधिक समय लेता है और 5 क्रेडिट जोड़ता है।
केवल ai_model meshy-7 (या latest) पर समर्थित है, और केवल preview mode पर।
Name
should_remesh
Type
boolean
डिफ़ॉल्ट false (meshy-6, meshy-7), true (अन्य)
Description
रीमेश चरण को सक्षम करने के लिए नियंत्रित करता है। उच्चतम गुणवत्ता वाले मॉडल के लिए, हम should_remesh को false पर सेट करने की अनुशंसा करते हैं।

केवल तब लागू होता है जब should_remesh = true

Name
topology
Type
string
डिफ़ॉल्ट triangle
Description
जनरेट किए गए मॉडल की topology निर्दिष्ट करें।
उपलब्ध मूल्य:
- quad: एक चौकोर-प्रमुख मेश जनरेट करें।
- triangle: एक डेसिमेटेड त्रिकोण मेश जनरेट करें।
Smart Topology आउटपुट केवल त्रिकोणीय है। ai_model: meshy-t2 के साथ quad का अनुरोध करने पर एक त्रुटि लौटाई जाती है।
Name
decimation_mode
Type
integer
Description
पॉलीकाउंट स्तर सेट करके ऐडेप्टिव डेसिमेशन को सक्षम करें। सेट करने पर, target_polycount को अनदेखा किया जाता है।
उपलब्ध मूल्य:
- 1: ऐडेप्टिव - अल्ट्रा पॉलीकाउंट।
- 2: ऐडेप्टिव - उच्च पॉलीकाउंट।
- 3: ऐडेप्टिव - मध्यम पॉलीकाउंट।
- 4: ऐडेप्टिव - निम्न पॉलीकाउंट।

Name
target_polycount
Type
integer
Description
आउटपुट में पॉलीगॉन (चेहरे) की लक्षित संख्या। वास्तविक संख्या ज्यामिति के आधार पर लक्ष्य से विचलित हो सकती है।
target_polycount दो स्वतंत्र मामलों में प्रभाव डालता है:
- रीमेश — standard मॉडल पर should_remesh: true के साथ। मेश को लगभग इस संख्या पर रीमेश (डेसिमेटेड) किया जाता है। रेंज 100 से 300,000, डिफॉल्ट 30,000। यदि decimation_mode सेट किया गया है, तो यह प्राथमिकता लेता है और target_polycount को अनदेखा किया जाता है।
- Smart Topology — model_type: smart-topology और ai_model: meshy-t2 के साथ। मॉडल को सीधे इस चेहरे की गणना पर जनरेट किया जाता है; कोई रीमेश नहीं चलता है और should_remesh की आवश्यकता नहीं होती है। रेंज 100 से 15,000, डिफॉल्ट 4,000।

Name
symmetry_mode
Type
string
⚠ पुराना
डिफ़ॉल्ट auto
Description
डेप्रिकेटेड। यह पैरामीटर अब आउटपुट को प्रभावित नहीं करता है।
symmetry_mode फील्ड मॉडल जनरेशन प्रक्रिया के दौरान सममिति व्यवहार को नियंत्रित करता है।
मान्य मूल्य हैं:
- off: सममिति को निष्क्रिय करें।
- auto: इनपुट ज्यामिति के आधार पर सममिति को स्वचालित रूप से निर्धारित करता है और लागू करता है।
- on: जनरेशन के दौरान सममिति को लागू करता है।
Name
pose_mode
Type
string
डिफ़ॉल्ट ""
Description
जनरेट किए गए मॉडल के लिए पोज़ mode निर्दिष्ट करें।
उपलब्ध मूल्य:
- a-pose: मॉडल को ए पोज़ में जनरेट करें।
- t-pose: मॉडल को टी पोज़ में जनरेट करें।
- "" (खाली स्ट्रिंग): कोई विशिष्ट पोज़ लागू नहीं किया गया।
Name
is_a_t_pose
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय pose_mode का उपयोग करें। क्या मॉडल को ए / टी पोज़ में जनरेट करें।
Name
art_style
Type
string
⚠ पुराना
डिफ़ॉल्ट realistic
Description
Meshy-6 द्वारा समर्थित नहीं। Meshy-6 का उपयोग करने वाले अनुरोध art_style को अनदेखा करेंगे, और कुछ संयोजनों से त्रुटियां हो सकती हैं। उपलब्ध मूल्य: realistic, sculpture.
enable_pbr को Sculpture शैली का उपयोग करते समय false पर सेट किया जाना चाहिए, क्योंकि Sculpture शैली अपने स्वयं के PBR मैप जनरेट करती है।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, इनपुट सामग्री को संभावित रूप से हानिकारक सामग्री के लिए स्वचालित रूप से स्क्रीन किया जाएगा। यदि हानिकारक सामग्री का पता चलता है, तो टास्क जनरेशन के लिए आगे नहीं बढ़ेगा।
prompt से टेक्स्ट को स्क्रीन किया जाएगा।
Name
target_formats
Type
string[]
Description
आउटपुट में शामिल करने के लिए किस 3D फ़ाइल स्वरूपों को निर्दिष्ट करता है। केवल अनुरोधित स्वरूप ही जनरेट और लौटाए जाएंगे, जो टास्क पूरा करने के समय को कम कर सकते हैं। छोड़े जाने पर, सभी समर्थित स्वरूप शामिल किए जाते हैं।
उपलब्ध मूल्य: glb, obj, fbx, stl, usdz, 3mf
छोड़ दिए जाने पर, 3mf को छोड़कर सभी स्वरूप उत्पन्न होते हैं। 3mf केवल तब शामिल किया जाता है जब इसे स्पष्ट रूप से निर्दिष्ट किया गया हो।
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो टास्क के अतिरिक्त एक पारदर्शी-पृष्ठभूमि (RGBA) संस्करण प्रस्तुत करता है और इसे GET प्रतिक्रिया पर alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहती है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, सेवा AI विजन का उपयोग करके वस्तु की वास्तविक-दुनिया की ऊंचाई का स्वचालित रूप से अनुमान लगाती है और मॉडल को तदनुसार आकार देती है। origin_at को स्पष्ट रूप से सेट नहीं किए जाने पर, ओरिजिन नीचे डिफॉल्ट होगा।

केवल तब लागू होता है जब auto_size = true

Name
origin_at
Type
string
डिफ़ॉल्ट bottom
Description
जब auto_size सक्षम होता है तो उत्पत्ति की स्थिति।
उपलब्ध मूल्य: bottom, center.

लौटाता है

प्रतिक्रिया की result प्रॉपर्टी में नव निर्मित टेक्स्ट से 3D टास्क का id शामिल होता है।

असफलता मोड

Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। आम कारण:
- लापता पैरामीटर: कोई आवश्यक पैरामीटर (जैसे, prompt, mode) गायब है।
- अमान्य पैरामीटर: art_style अनुमत मानों में से एक नहीं है।
- Prompt बहुत लम्बा है: prompt वर्ण सीमा से अधिक है।
Name
401 - Unauthorized
Description
प्रमाणीकरण असफल। कृपया अपनी API key की जांच करें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए पर्याप्त क्रेडिट नहीं है।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट को पार कर लिया है।

Request

POST

/openapi/v2/text-to-3d

# केवल आवश्यक पैरामीटर के साथ सरल प्रीव्यू
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# रीमेश और ए-पोज़ के साथ प्रीव्यू
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

POST/openapi/v2/text-to-3d

एक टेक्स्ट से 3D रिफाइन टास्क बनाएं

यह एंडपॉइंट एक टेक्स्ट से 3D रिफाइन टास्क बनाता है, जो एक पूर्ण प्रीव्यू मेश पर टेक्सचर लागू करता है। आपको एक सफल प्रीव्यू टास्क से preview_task_id प्रदान करना होगा। यह दो-चरणीय वर्कफ़्लो का दूसरा चरण है।

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
जब रिफाइन टास्क बनाते हैं तो इस फील्ड को "refine" पर सेट किया जाना चाहिए।
Name
preview_task_id
Type
string
आवश्यक
Description
संबंधित प्रीव्यू टास्क आईडी।
दिए गए प्रीव्यू टास्क की स्थिति SUCCEEDED होनी चाहिए।
Name
enable_pbr
Type
boolean
डिफ़ॉल्ट false
Description
बेस कलर के अलावा PBR मैप (धातविक, रूखापन, नॉर्मल) जनरेट करता है। ai_model meshy-6 होने पर उत्सर्जन मानचित्र भी शामिल होता है, 8k में texture_resolution के अलावा (कोई उत्सर्जन मानचित्र उत्पन्न नहीं होता)। meshy-7 (और latest) उत्सर्जन मानचित्र उत्पन्न नहीं करता।
Name
texture_resolution
Type
string
डिफ़ॉल्ट 2k
Description
बेस कलर टेक्सचर रिज़ॉल्यूशन। 2k (2048×2048), 4k (4096×4096), या 8k (8192×8192) में से एक। उच्चतर रिज़ॉल्यूशन अधिक सतह विवरण को कैप्चर करते हैं। केवल refine mode पर लागू होता है।
4k और 8k के लिए ai_model meshy-6, meshy-7, या latest की आवश्यकता होती है। 8k में कोई उत्सर्जन मानचित्र उत्पन्न नहीं होता।
Name
hd_texture
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
texture_resolution का उपयोग करें — texture_resolution: "4k" के समतुल्य। यदि दोनों सेट होते हैं, तो texture_resolution प्राथमिकता प्राप्त करता है।
Name
texture_prompt
Type
string
Description
टेक्सचरिंग प्रक्रिया को मार्गदर्शन करने के लिए एक अतिरिक्त टेक्स्ट prompt प्रदान करें। अधिकतम 600 वर्ण।
Name
texture_image_url
Type
string
Description
टेक्सचरिंग प्रक्रिया को मार्गदर्शन करने के लिए एक 2D छवि प्रदान करें। हम वर्तमान में .jpg, .jpeg, और .png प्रारूपों का समर्थन करते हैं।
छवि प्रदान करने के दो तरीके हैं:
- सार्वजनिक रूप से सुलभ URL: एक URL जो सार्वजनिक इंटरनेट से सुलभ है
- Data URI: छवि के बेस64-एन्कोडेड डेटा URI। Data URI का एक उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>
यदि मौलिक संपत्ति और अपलोड की गई छवि के बीच पर्याप्त ज्यामिति अंतराल हैं, तो छवि टेक्सचरिंग इष्टतम रूप से काम नहीं कर सकती है। टेक्सचरिंग प्रक्रिया को मार्गदर्शन करने के लिए केवल texture_image_url या texture_prompt का उपयोग किया जा सकता है। यदि दोनों पैरामीटर प्रदान किए जाते हैं, तो texture_prompt को मॉडल को टेक्सचर करने के लिए डिफॉल्ट रूप से उपयोग किया जाएगा।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
रिफाइनिंग के लिए उपयोग करने वाले मॉडल का आईडी। उपलब्ध वृद्धि: meshy-5, meshy-6, meshy-7, latest (Meshy 7)।
यहां latest ठीक उसी तरह हल होता है जैसे प्रीव्यू टास्क पर होता है (फिलहाल Meshy 7), यही वजह है कि latest प्रीव्यू और उसका latest रिफाइन हमेशा एक ही टेक्सचर मॉडल पर पहुंचते हैं।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, इनपुट सामग्री को संभावित रूप से हानिकारक सामग्री के लिए स्वचालित रूप से स्क्रीन किया जाएगा। यदि हानिकारक सामग्री का पता चलता है, तो टास्क जनरेशन के लिए आगे नहीं बढ़ेगा।
texture_prompt से टेक्स्ट और texture_image_url की छवि दोनों को स्क्रीन किया जाएगा।
Name
remove_lighting
Type
boolean
डिफ़ॉल्ट true
Description
बेस कलर टेक्सचर से हाइलाइट्स और शैडो को हटा देता है, जिससे एक साफ-सुथरा परिणाम प्राप्त होता है जो कस्टम लाइटिंग सेटअप के अंतर्गत बेहतर काम करता है।
केवल तब प्रभाव डालता है जब ai_model meshy-6 हो। meshy-7 (और latest) पर पैरामीटर को स्वीकार किया जाता है लेकिन अनदेखा किया जाता है।
Name
target_formats
Type
string[]
Description
आउटपुट में शामिल करने के लिए किस 3D फ़ाइल स्वरूपों को निर्दिष्ट करता है। केवल अनुरोधित स्वरूप ही जनरेट और लौटाए जाएंगे, जो टास्क पूरा करने के समय को कम कर सकते हैं। छोड़े जाने पर, सभी समर्थित स्वरूप शामिल किए जाते हैं।
उपलब्ध मूल्य: glb, obj, fbx, stl, usdz, 3mf
छोड़ दिए जाने पर, 3mf को छोड़कर सभी स्वरूप उत्पन्न होते हैं। 3mf केवल तब शामिल किया जाता है जब इसे स्पष्ट रूप से निर्दिष्ट किया गया हो।
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो टास्क के अतिरिक्त एक पारदर्शी-पृष्ठभूमि (RGBA) संस्करण प्रस्तुत करता है और इसे GET प्रतिक्रिया पर alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहती है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, सेवा AI विजन का उपयोग करके वस्तु की वास्तविक-दुनिया की ऊंचाई का स्वचालित रूप से अनुमान लगाती है और मॉडल को तदनुसार आकार देती है। origin_at को स्पष्ट रूप से सेट नहीं किए जाने पर, ओरिजिन नीचे डिफॉल्ट होगा।

केवल तब लागू होता है जब auto_size = true

Name
origin_at
Type
string
डिफ़ॉल्ट bottom
Description
जब auto_size सक्षम होता है तो उत्पत्ति की स्थिति।
उपलब्ध मूल्य: bottom, center.

लौटाता है

असफलता मोड

Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। आम कारण:
- अमान्य टास्क आईडी: preview_task_id अमान्य है या अस्तित्व में नहीं है।
- टास्क तैयार नहीं है: प्रीव्यू टास्क अभी तक सफल नहीं हुआ है।
- मॉडल का मिसमैच: प्रीव्यू टास्क का AI मॉडल अनुरोधित रिफाइन मॉडल के साथ असंगत है।
Name
401 - Unauthorized
Description
प्रमाणीकरण असफल। कृपया अपनी API key की जांच करें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए पर्याप्त क्रेडिट नहीं है।
Name
404 - Not Found
Description
preview_task_id द्वारा निर्दिष्ट प्रीव्यू टास्क नहीं मिला।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट को पार कर लिया है।

Request

POST

/openapi/v2/text-to-3d

# मूलभूत रिफाइन टास्क
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# ऑटो-आकार और GLB स्वरूप के साथ रिफाइन करें
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v2/text-to-3d/:id

एक टेक्स्ट से 3D टास्क प्राप्त करें

यह एंडपॉइंट आपको एक वैध टास्क id को दिए गए एक टेक्स्ट से 3D टास्क को पुनःप्राप्त करने की अनुमति देता है। शामिल गुणों को देखने के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट को देखें।

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

पैरामीटर

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

लौटाता है

प्रतिक्रिया टेक्स्ट से 3D टास्क ऑब्जेक्ट को शामिल करता है। विवरण के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट सेक्शन की जाँच करें।

उदाहरण

Mode	नमूना मॉडल
Preview
Refine

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

एक टेक्स्ट से 3D टास्क हटाएं

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

पथ पैरामीटर

Name
id
Type
path
Description
हटाने के लिए टेक्स्ट से 3D टास्क का आईडी।

लौटाता है

सफल होने पर 200 OK लौटाता है।

Request

DELETE

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// सफल होने पर 200 Ok लौटाता है।

GET/openapi/v2/text-to-3d

टेक्स्ट से 3D टास्क सूचीबद्ध करें

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

पैरामीटर

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: सृजन समय को अवरोही क्रम में क्रमबद्ध करता है।

लौटाता है

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

Request

GET

/openapi/v2/text-to-3d

curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

टेक्स्ट से 3D टास्क स्ट्रीम करें

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

पैरामीटर

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

लौटाता है

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

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

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// त्रुटि ईवेंट का उदाहरण
event: error
data: {
  "status_code": 404,
  "message": "टास्क नहीं मिला"
}

// संदेश ईवेंट उदाहरण टास्क की प्रगति को दर्शाते हैं।
// PENDING या IN_PROGRESS टास्क के लिए, प्रतिक्रिया धारा में सभी फील्ड शामिल नहीं होंगे।
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"texture_urls": [
  {
    "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
    "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
    "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
    "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
    "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
  }
],
"preceding_tasks": 0,
"task_error": {

  "message": ""

},

"consumed_credits": 20
}

टेक्स्ट से 3D टास्क ऑब्जेक्ट

टेक्स्ट से 3D टास्क ऑब्जेक्ट एक यूनिट ऑफ़ वर्क है जिसे Meshy ट्रैक करता है ताकि एक टेक्स्ट इनपुट से एक 3D मॉडल जनरेट कर सके। टेक्स्ट से 3D API के दो चरण हैं, preview और refine। प्रीव्यू चरण केवल मेश-ओनली 3D मॉडल जनरेट करने के लिए होता है, और रिफाइन चरण प्रीव्यू चरण के परिणाम पर आधारित एक टेक्सचरयुक्त 3D मॉडल बनाने के लिए होता है।

इस ऑब्जेक्ट में निम्नलिखित गुण होते हैं:

प्रॉपर्टीज़

Name
id
Type
string
Description
टास्क का अद्वितीय पहचानकर्ता। हम कार्य आईडी के लिए एक के-स्टेबल UUID का उपयोग करते हुए भी, आपको आईडी के प्रारूप के बारे में कोई धारणा नहीं बनानी चाहिए।
Name
type
Type
string
Description
टेक्स्ट से 3D टास्क का प्रकार। संभावित मूल्य text-to-3d-preview प्रीव्यू चरण के टास्क के लिए और text-to-3d-refine रिफाइन चरण के टास्क के लिए हैं।
Name
model_urls
Type
object
Description
Meshy द्वारा जनरेट किए गए टेक्सचरयुक्त 3D मॉडल फ़ाइल के लिए डाउनलोड करने योग्य URL। यदि स्वरूप जनरेट नहीं किया जाता है तो एक खाली स्ट्रिंग लौटाने के बजाय स्वरूप के लिए प्रॉपर्टी को छोड़ दिया जाएगा।
- Name
  glb
  Type
  string
  Description
  GLB फ़ाइल के लिए डाउनलोड करने योग्य URL।
- Name
  fbx
  Type
  string
  Description
  FBX फ़ाइल के लिए डाउनलोड करने योग्य URL।
- Name
  usdz
  Type
  string
  Description
  USDZ फ़ाइल के लिए डाउनलोड करने योग्य URL।
- Name
  obj
  Type
  string
  Description
  OBJ फ़ाइल के लिए डाउनलोड करने योग्य URL।
- Name
  mtl
  Type
  string
  Description
  MTL फ़ाइल के लिए डाउनलोड करने योग्य URL।
- Name
  stl
  Type
  string
  Description
  STL फ़ाइल के लिए डाउनलोड करने योग्य URL।
- Name
  3mf
  Type
  string
  Description
  3MF फ़ाइल के लिए डाउनलोड करने योग्य URL। केवल तब उपस्थित जब 3mf को target_formats के माध्यम से अनुरोध किया गया था।
Name
prompt
Type
string
Description
यह वह अपरिवर्तित prompt है जिसका उपयोग टास्क बनाने के लिए किया गया था।
Name
negative_prompt
Type
string
⚠ पुराना
Description
पिछड़े संगतता बनाए रखने के लिए। इस फ़ील्ड का जनरेट किए गए मॉडल पर कोई कार्यात्मक प्रभाव नहीं है।
Name
art_style
Type
string
⚠ पुराना
Description
प्रीव्यू टास्क बनाने के लिए उपयोग किए गए अपरिवर्तित art_style। Meshy-6 द्वारा समर्थित नहीं।
Name
texture_richness
Type
string
⚠ पुराना
Description
पिछड़े संगतता बनाए रखने के लिए। इस फ़ील्ड का जनरेट किए गए मॉडल पर कोई कार्यात्मक प्रभाव नहीं है।
Name
texture_prompt
Type
string
Description
रिफाइन चरण के दौरान टेक्सचरिंग प्रक्रिया को मार्गदर्शन करने के लिए प्रदान किया गया अतिरिक्त टेक्स्ट प्रम्प्ट।
Name
ultra_mode
Type
boolean
Description
ultra_mode मान को प्रतिध्वनित करता है जिसे प्रीव्यू टास्क के साथ उत्पन्न किया गया था। केवल meshy-7 (या latest) प्रीव्यू टास्क के लिए मौजूद है जो स्पष्ट रूप से ultra_mode सेट करते हैं; अन्यथा छोड़ दिया गया।
Name
texture_image_url
Type
string
Description
टेक्सचरिंग प्रक्रिया को मार्गदर्शन करने के लिए उपयोग की गई टेक्सचर छवि के लिए डाउनलोड करने योग्य URL।
Name
thumbnail_url
Type
string
Description
मॉडल फ़ाइल की थंबनेल छवि के लिए डाउनलोड करने योग्य URL।
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url के पारदर्शी-पृष्ठभूमि (RGBA) संस्करण के लिए डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब टास्क को alpha_thumbnail: true के साथ बनाया गया हो और पारदर्शी प्रीव्यू सफलतापूर्वक प्रस्तुत किया गया हो; अन्यथा यह फ़ील्ड छोड़ी जाती है।
Name
video_url
Type
string
⚠ पुराना
Description
प्रीव्यू वीडियो के लिए डाउनलोड करने योग्य URL। भविष्य की रिलीज़ में हटा दिया जाएगा।
Name
progress
Type
integer
Description
टास्क की प्रगति। यदि टास्क अभी तक शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी। एक बार टास्क सफल हो जाने पर, यह 100 हो जाएगा।
Name
started_at
Type
timestamp
Description
जिस समय टास्क शुरू हुआ था, उस समय की टाइमस्टैंप, मिलिसेकंड में। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
एक टाइमस्टैंप 1 जनवरी, 1970 UTC से बिताए गए मिलिसेकंड की संख्या का प्रतिनिधित्व करता है, RFC 3339 मानक का पालन करते हुए। उदाहरण के लिए, शुक्रवार, 1 सितंबर, 2023 12:00:00 PM GMT को 1693569600000 के रूप में दर्शाया गया है। यह Meshy API में सभी टाइमस्टैंप पर लागू होता है।
Name
created_at
Type
timestamp
Description
जिस समय टास्क बनाया गया था उसका टाइमस्टैंप, मिलिसेकंड में।
Name
finished_at
Type
timestamp
Description
जिस समय टास्क पूरा हुआ था का टाइमस्टैंप, मिलिसेकंड में। यदि टास्क अभी समाप्त नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
Name
status
Type
string
Description
टास्क की स्थिति। संभावित मूल्य PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक होते हैं।
Name
texture_urls
Type
array
Description
एक टास्क से जनरेट की गई टेक्सचर URL ऑब्जेक्ट्स की एक ऐरे होती है। सामान्य रूप से इसमें केवल एक टेक्सचर URL ऑब्जेक्ट होती है। प्रत्येक टेक्सचर URL में निम्नलिखित गुण होते हैं:
- Name
  base_color
  Type
  string
  Description
  बेस कलर मैप की छवि के लिए डाउनलोड करने योग्य URL।
- Name
  metallic
  Type
  string
  Description
  धातविक मैप की छवि के लिए डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ी जाएगी।
- Name
  normal
  Type
  string
  Description
  नॉर्मल मैप की छवि के लिए डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ी जाएगी।
- Name
  roughness
  Type
  string
  Description
  रूखापन मैप की छवि के लिए डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ी जाएगी।
- Name
  emission
  Type
  string
  Description
  उत्सर्जन मैप की छवि के लिए डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, या ai_model meshy-5 है, तो यह प्रॉपर्टी छोड़ी जाएगी।
Name
preceding_tasks
Type
integer
Description
पूर्ववर्ती टास्क की गणना।
इस फ़ील्ड का मूल्य केवल तभी अर्थपूर्ण होता है जब टास्क की स्थिति PENDING हो।
Name
task_error
Type
object
Description
विफल टास्क के लिए एरर विवरण। पूर्ण task_error ऑब्जेक्ट संदर्भ के लिए एरर को देखें।
Name
consumed_credits
Type
integer
Description
इस टास्क द्वारा उपभोक्त क्रेडिट की संख्या। जब टास्क की स्थिति PENDING, IN_PROGRESS, या SUCCEEDED होती है, तब मौजूद होती है। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट रिफंड किए जाते हैं)।

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}