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

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

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

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

Text to 3D Preview टास्क बनाएं

यह एंडपॉइंट एक Text to 3D preview टास्क बनाता है, जो एक टेक्स्ट prompt से बिना टेक्सचर वाला 3D मेश (केवल ज्यामिति) जनरेट करता है। यह दो-चरणीय वर्कफ़्लो का पहला चरण है। एक बार preview सफल हो जाने पर, टेक्सचरिंग के लिए refine टास्क बनाने हेतु लौटाए गए टास्क ID का उपयोग करें। पूरे response स्कीमा के लिए The Text to 3D Task Object देखें।

पैरामीटर

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

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

Name
topology
Type
string
डिफ़ॉल्ट triangle
Description
जनरेट किए गए मॉडल की topology निर्दिष्ट करें।
उपलब्ध मान:
- quad: एक quad-प्रधान मेश जनरेट करें।
- triangle: एक डेसिमेटेड triangle मेश जनरेट करें।
Smart Topology आउटपुट केवल triangle होता है। 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 दो स्वतंत्र मामलों में प्रभावी होता है:
- Remesh — standard मॉडल पर should_remesh: true के साथ। मेश को लगभग इस संख्या तक remesh (डेसिमेट) किया जाता है। रेंज 100 से 300,000, डिफ़ॉल्ट 30,000। यदि decimation_mode सेट है, तो उसे प्राथमिकता मिलती है और target_polycount को नज़रअंदाज़ कर दिया जाता है।
- Smart Topology — model_type: smart-topology और ai_model: meshy-t2 के साथ। मॉडल सीधे इसी फेस काउंट पर जनरेट किया जाता है; कोई remesh नहीं चलता और 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
जनरेट किए गए मॉडल के लिए pose mode निर्दिष्ट करें।
उपलब्ध मान:
- a-pose: मॉडल को A पोज़ में जनरेट करें।
- t-pose: मॉडल को T पोज़ में जनरेट करें।
- "" (खाली स्ट्रिंग): कोई विशिष्ट पोज़ लागू नहीं।
Name
is_a_t_pose
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय pose_mode का उपयोग करें। क्या मॉडल को A/T पोज़ में जनरेट किया जाए।
Name
art_style
Type
string
⚠ पुराना
डिफ़ॉल्ट realistic
Description
Meshy-6 द्वारा समर्थित नहीं है। Meshy-6 का उपयोग करने वाले अनुरोध art_style को नज़रअंदाज़ कर देंगे, और कुछ संयोजनों से एरर हो सकती है। उपलब्ध मान: realistic, sculpture।
Sculpture स्टाइल का उपयोग करते समय enable_pbr को 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 पर सेट होने पर, टास्क अतिरिक्त रूप से preview का एक ट्रांसपेरेंट-बैकग्राउंड (RGBA) संस्करण रेंडर करता है और उसे GET response पर alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहती है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
true पर सेट होने पर, सेवा ऑब्जेक्ट की वास्तविक-दुनिया की ऊँचाई का स्वचालित रूप से अनुमान लगाने और उसके अनुसार मॉडल को रीसाइज़ करने के लिए AI विज़न का उपयोग करती है। जब तक origin_at स्पष्ट रूप से सेट न किया जाए, ओरिजिन डिफ़ॉल्ट रूप से bottom होगा।

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

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

रिटर्न

Response की result प्रॉपर्टी में नए बनाए गए Text to 3D टास्क की टास्क id होती है।

विफलता मोड

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

Request

POST

/openapi/v2/text-to-3d

# Simple preview with required params only
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"
}'

# Preview with remesh and A-pose
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

Create a Text to 3D Refine Task

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

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
refine task बनाते समय इस फ़ील्ड को "refine" पर सेट किया जाना चाहिए।
Name
preview_task_id
Type
string
आवश्यक
Description
संबंधित preview task की id।
दी गई preview task की स्थिति SUCCEEDED होनी चाहिए।
Name
enable_pbr
Type
boolean
डिफ़ॉल्ट false
Description
बेस कलर के अतिरिक्त PBR मैप (metallic, roughness, normal) जनरेट करें। जब ai_model, meshy-6 हो, तो एक emission मैप भी शामिल होता है, सिवाय texture_resolution: 8k के (इस स्थिति में कोई emission मैप उत्पन्न नहीं होता)। meshy-7 (और latest) कोई emission मैप उत्पन्न नहीं करता।
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 पर, कोई emission मैप उत्पन्न नहीं होता।
Name
hd_texture
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय texture_resolution का उपयोग करें — यह texture_resolution: "4k" के बराबर है। जब दोनों सेट किए जाते हैं, तो texture_resolution को प्राथमिकता दी जाती है।
Name
texture_prompt
Type
string
Description
टेक्सचरिंग प्रक्रिया को मार्गदर्शन देने के लिए एक अतिरिक्त टेक्स्ट prompt प्रदान करें। अधिकतम 800 वर्ण।
Name
texture_image_url
Type
string
Description
टेक्सचरिंग प्रक्रिया को मार्गदर्शन देने के लिए एक 2d इमेज प्रदान करें। हम वर्तमान में .jpg, .jpeg, और .png फ़ॉर्मेट को सपोर्ट करते हैं।
इमेज प्रदान करने के दो तरीके हैं:
- सार्वजनिक रूप से एक्सेस योग्य URL: एक URL जो सार्वजनिक इंटरनेट से एक्सेस योग्य है
- Data URI: इमेज का एक base64-एन्कोडेड data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>
यदि मूल एसेट और अपलोड की गई इमेज के बीच पर्याप्त ज्यामिति अंतर हो, तो इमेज टेक्सचरिंग सर्वोत्तम ढंग से काम नहीं कर सकती। टेक्सचरिंग प्रक्रिया को मार्गदर्शन देने के लिए texture_image_url या texture_prompt में से केवल एक का उपयोग किया जा सकता है। यदि दोनों पैरामीटर प्रदान किए जाते हैं, तो डिफ़ॉल्ट रूप से मॉडल को टेक्सचर करने के लिए texture_prompt का उपयोग किया जाएगा।
Name
ai_model
Type
string
डिफ़ॉल्ट inherited from the preview task
Description
refining के लिए उपयोग किए जाने वाले मॉडल की ID। उपलब्ध मान: meshy-5, meshy-6, meshy-7, latest (Meshy 7)।
preview task द्वारा उपयोग किए गए मॉडल को विरासत में लेने के लिए इस पैरामीटर को छोड़ दें, जिससे एक preview और उसका refine शुरू से अंत तक एक ही मॉडल पर बने रहते हैं। उस विरासत को ओवरराइड करने के लिए एक स्पष्ट मान पास करें।
एक स्पष्ट latest यहाँ बिल्कुल वैसे ही हल होता है जैसे यह preview task पर होता है (वर्तमान में Meshy 7), इसलिए एक latest preview और उसका latest refine हमेशा एक ही टेक्सचर मॉडल पर उतरते हैं।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो इनपुट सामग्री की संभावित हानिकारक सामग्री के लिए स्वचालित रूप से जांच की जाएगी। यदि हानिकारक सामग्री का पता चलता है, तो task जनरेशन के लिए आगे नहीं बढ़ेगा।
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 फ़ाइल फ़ॉर्मेट शामिल किए जाएं। केवल अनुरोधित फ़ॉर्मेट ही जनरेट और रिटर्न किए जाएंगे, जिससे task के पूरा होने का समय कम हो सकता है। जब छोड़ दिया जाता है, तो सभी समर्थित फ़ॉर्मेट शामिल किए जाते हैं।
उपलब्ध मान: glb, obj, fbx, stl, usdz, 3mf
जब छोड़ दिया जाता है, तो 3mf को छोड़कर सभी फ़ॉर्मेट जनरेट किए जाते हैं। 3mf केवल तभी शामिल होता है जब इसे स्पष्ट रूप से निर्दिष्ट किया गया हो।
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो task अतिरिक्त रूप से preview का एक ट्रांसपैरेंट-बैकग्राउंड (RGBA) वर्शन रेंडर करता है और इसे GET रिस्पॉन्स पर alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहती है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो सेवा ऑब्जेक्ट की वास्तविक-दुनिया की ऊंचाई का स्वचालित रूप से अनुमान लगाने के लिए AI विज़न का उपयोग करती है और उसके अनुसार मॉडल का आकार बदलती है। जब तक origin_at को स्पष्ट रूप से सेट नहीं किया जाता, ओरिजिन डिफ़ॉल्ट रूप से bottom होगा।

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

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

रिटर्न

रिस्पॉन्स की result प्रॉपर्टी में नई बनाई गई Text to 3D task की id शामिल होती है।

विफलता मोड

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

Request

POST

/openapi/v2/text-to-3d

# Basic refine task
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
}'

# Refine with auto-size and GLB format
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 टास्क ऑब्जेक्ट में कौन-कौन से properties शामिल हैं, यह देखने के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट देखें।

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

पैरामीटर

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 टास्क की ID।

रिटर्न

सफल होने पर 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

// Returns 200 Ok on success.

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

Text to 3D कार्यों की सूची

यह एंडपॉइंट आपको Text to 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: निर्माण समय के अनुसार अवरोही क्रम में सॉर्ट करें।

रिटर्न्स

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

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

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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
}

The Text to 3D Task Object

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

ऑब्जेक्ट में निम्नलिखित प्रॉपर्टी होती हैं:

Properties

Name
id
Type
string
Description
टास्क के लिए यूनीक पहचानकर्ता। भले ही हम टास्क id के लिए इम्प्लीमेंटेशन डिटेल के रूप में k-sortable UUID का उपयोग करते हैं, आपको id के फॉर्मेट के बारे में कोई धारणा नहीं बनानी चाहिए।
Name
type
Type
string
Description
टेक्स्ट से 3D टास्क का प्रकार। संभावित मान हैं preview चरण के टास्क के लिए text-to-3d-preview और refine चरण के टास्क के लिए 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। यह केवल तभी मौजूद होता है जब target_formats के माध्यम से 3mf का अनुरोध किया गया हो।
Name
prompt
Type
string
Description
यह वही अपरिवर्तित prompt है जिसका उपयोग टास्क बनाने के लिए किया गया था।
Name
negative_prompt
Type
string
⚠ पुराना
Description
बैकवर्ड कम्पैटिबिलिटी के लिए बनाए रखा गया है। इस फ़ील्ड का जनरेट किए गए मॉडल पर कोई कार्यात्मक प्रभाव नहीं है।
Name
art_style
Type
string
⚠ पुराना
Description
वही अपरिवर्तित art_style जिसका उपयोग preview टास्क बनाने के लिए किया गया था। Meshy-6 द्वारा समर्थित नहीं है।
Name
texture_richness
Type
string
⚠ पुराना
Description
बैकवर्ड कम्पैटिबिलिटी के लिए बनाए रखा गया है। इस फ़ील्ड का जनरेट किए गए मॉडल पर कोई कार्यात्मक प्रभाव नहीं है।
Name
texture_prompt
Type
string
Description
refine चरण के दौरान टेक्सचरिंग प्रक्रिया का मार्गदर्शन करने के लिए प्रदान किया गया अतिरिक्त टेक्स्ट prompt।
Name
ultra_mode
Type
boolean
Description
वह ultra_mode मान दर्शाता है जिसके साथ preview टास्क बनाया गया था। यह केवल उन meshy-7 (या latest) preview टास्क के लिए मौजूद होता है जिन्होंने स्पष्ट रूप से 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 होगी।
एक टाइमस्टैंप RFC 3339 मानक का पालन करते हुए, 1 जनवरी, 1970 UTC से बीते मिलीसेकंड की संख्या दर्शाता है। उदाहरण के लिए, शुक्रवार, 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
टास्क से जनरेट किए गए texture URL ऑब्जेक्ट का एक ऐरे। सामान्यतः इसमें केवल एक texture URL ऑब्जेक्ट होता है। प्रत्येक texture URL में निम्नलिखित प्रॉपर्टी होती हैं:
- Name
  base_color
  Type
  string
  Description
  base color मैप इमेज का डाउनलोड करने योग्य URL।
- Name
  metallic
  Type
  string
  Description
  metallic मैप इमेज का डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, तो इस प्रॉपर्टी को छोड़ दिया जाएगा।
- Name
  normal
  Type
  string
  Description
  नॉर्मल मैप इमेज का डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, तो इस प्रॉपर्टी को छोड़ दिया जाएगा।
- Name
  roughness
  Type
  string
  Description
  roughness मैप इमेज का डाउनलोड करने योग्य URL।
  यदि टास्क enable_pbr: false के साथ बनाया गया है, तो इस प्रॉपर्टी को छोड़ दिया जाएगा।
- Name
  emission
  Type
  string
  Description
  emission मैप इमेज का डाउनलोड करने योग्य 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
}