टेक्स्ट से 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

टेक्स्ट से 3D Preview टास्क बनाएँ

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

टास्क बैकग्राउंड में चलता है। इसमें आमतौर पर कितना समय लगता है, यह जानने के लिए Processing Times देखें।

पैरामीटर

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 या meshy-t2.5) के साथ एक Smart Topology मॉडल चुनें।
- lowpoly (डेप्रिकेटेड, 30 अक्टूबर, 2026 को रिटायर हो रहा है): साफ़ पॉलीगॉन के लिए ऑप्टिमाइज़ किया गया लो-पॉली मेश जनरेट करता है। हम इसके बजाय Meshy T2.5 की सिफ़ारिश करते हैं: meshy-t2.5 के साथ smart-topology।
जब smart-topology चुना जाता है, तो should_remesh और decimation_mode को नज़रअंदाज़ कर दिया जाता है, और केवल topology: triangle स्वीकार किया जाता है।
lowpoly 30 अक्टूबर, 2026 को रिटायर कर दिया जाएगा। उस तिथि के बाद, model_type: "lowpoly" वाले अनुरोध एरर लौटाएंगे। हम Meshy T2.5 (ai_model: "meshy-t2.5" के साथ model_type: "smart-topology") पर स्विच करने की सिफ़ारिश करते हैं। जब lowpoly चुना जाता है, तो ai_model, topology, target_polycount, और should_remesh को नज़रअंदाज़ कर दिया जाता है।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
उपयोग करने के लिए मॉडल की ID। उपलब्ध मान model_type पर निर्भर करते हैं।
मानक जनरेशन (model_type: standard):
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (डेप्रिकेटेड): इसके बजाय meshy-7.1 का उपयोग करें।
Smart Topology जनरेशन (model_type: smart-topology):
- meshy-t2: Smart Topology मॉडल — साफ़ topology, स्वाभाविक रूप से अलग किए गए हिस्से, triangle आउटपुट, और एक फेस काउंट जिसे आप target_polycount से सेट कर सकते हैं।
- meshy-t2.5 (डिफ़ॉल्ट): गेम असेट्स के लिए तीक्ष्ण विवरण। triangle आउटपुट, और एक फेस काउंट जिसे आप target_polycount से सेट कर सकते हैं।
Name
geometry_resolution
Type
string
डिफ़ॉल्ट standard
Description
ज्यामिति जनरेशन पास। 2k Ultra पास को 2048³ पर चलाता है; 4k इसे सबसे बेहतरीन सतह विवरण के लिए 4096³ पर चलाता है।
उपलब्ध मान: standard, 2k, 4k
केवल preview mode पर समर्थित। इसके लिए meshy-7.1 या latest आवश्यक है।
Name
ultra_mode
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय geometry_resolution का उपयोग करें। ultra_mode: true, geometry_resolution: "2k" के बराबर है।
Name
should_remesh
Type
boolean
डिफ़ॉल्ट false (Meshy 6 and Meshy 7 models), 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 या meshy-t2.5 के साथ 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 या meshy-t2.5 के साथ। मॉडल सीधे इस फेस काउंट पर जनरेट किया जाता है; कोई रीमेश नहीं चलता और should_remesh आवश्यक नहीं है। meshy-t2 के लिए: सीमा 100 से 15,000, डिफ़ॉल्ट 4,000। meshy-t2.5 के लिए: सीमा 100 से 30,000, डिफ़ॉल्ट 15,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 रिस्पॉन्स पर alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहती है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो सेवा ऑब्जेक्ट की वास्तविक-दुनिया ऊँचाई का स्वचालित रूप से अनुमान लगाने के लिए AI विज़न का उपयोग करती है और तदनुसार मॉडल को रीसाइज़ करती है। ओरिजिन डिफ़ॉल्ट रूप से bottom होगा जब तक कि origin_at स्पष्ट रूप से सेट न किया गया हो।

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

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

रिटर्न

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

Failure Modes

Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
- पैरामीटर गायब: एक आवश्यक पैरामीटर (जैसे, prompt, mode) गायब है।
- अमान्य पैरामीटर: art_style अनुमत मानों में से एक नहीं है।
- Prompt बहुत लंबा: prompt अक्षर सीमा से अधिक है।
- लो पॉली के लिए असमर्थित मॉडल: ai_model: "meshy-6-lite", model_type: "lowpoly" को समर्थन नहीं देता।
- Ultra के लिए असमर्थित मॉडल: geometry_resolution के लिए meshy-7.1 या latest आवश्यक है।
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 Ultra 4K geometry, 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",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "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 Refine टास्क बनाएं

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

यह टास्क बैकग्राउंड में चलता है। इसमें आमतौर पर कितना समय लगता है, यह जानने के लिए प्रोसेसिंग टाइम्स देखें।

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
refine टास्क बनाते समय इस फ़ील्ड को "refine" पर सेट किया जाना चाहिए।
Name
preview_task_id
Type
string
आवश्यक
Description
संबंधित प्रीव्यू टास्क की id।
दी गई प्रीव्यू टास्क की स्थिति SUCCEEDED होनी चाहिए।
Name
enable_pbr
Type
boolean
डिफ़ॉल्ट false
Description
बेस कलर के अतिरिक्त PBR मैप (मेटैलिक, रफनेस, नॉर्मल) जनरेट करें। जब ai_model, meshy-6 हो, तो एक एमिशन मैप भी शामिल किया जाता है, सिवाय texture_resolution: 8k के (कोई एमिशन मैप उत्पन्न नहीं होता)। meshy-6-lite, meshy-7.1 और latest एमिशन मैप उत्पन्न नहीं करते, और न ही किसी ऐसे meshy-t2 प्रीव्यू के refine में जो ai_model सेट नहीं करता।
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.1, या latest आवश्यक है। 8k पर, कोई एमिशन मैप उत्पन्न नहीं होता।
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, और .webp फॉर्मेट सपोर्ट करते हैं।
अधिकतम फ़ाइल आकार: 20 MB।
इमेज प्रदान करने के दो तरीके हैं:
- सार्वजनिक रूप से सुलभ 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
रिफाइनिंग के लिए उपयोग किए जाने वाले मॉडल की ID।
उपलब्ध मान:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (डेप्रिकेटेड): इसके बजाय meshy-7.1 का उपयोग करें।
प्रीव्यू टास्क द्वारा उपयोग किए गए मॉडल को इनहेरिट करने के लिए इस पैरामीटर को छोड़ दें, जो एक प्रीव्यू और उसके refine को शुरू से अंत तक एक ही मॉडल पर रखता है। उस इनहेरिटेंस को ओवरराइड करने के लिए एक स्पष्ट मान पास करें।
यहाँ एक स्पष्ट latest ठीक उसी तरह रिज़ॉल्व होता है जैसे वह प्रीव्यू टास्क पर करता है (वर्तमान में Meshy 7.1), इसलिए एक latest प्रीव्यू और उसका latest refine हमेशा एक ही टेक्सचर मॉडल पर स्थिर होते हैं।
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.1 और latest इसे स्वीकार करते हैं और इसे अनदेखा करते हैं, जैसा कि किसी ऐसे meshy-t2 प्रीव्यू के refine में भी होता है जो ai_model सेट नहीं करता। meshy-6-lite के साथ इसे सेट करने पर एक एरर मिलती है।
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 स्पष्ट रूप से सेट न हो, ओरिजिन डिफ़ॉल्ट रूप से bottom होगा।

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

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

रिटर्न

रिस्पॉन्स की result प्रॉपर्टी में नए बनाए गए टेक्स्ट से 3D टास्क की टास्क id शामिल है।

विफलता के तरीके

Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
- अमान्य टास्क ID: preview_task_id अमान्य है या मौजूद नहीं है।
- टास्क तैयार नहीं है: प्रीव्यू टास्क अभी सफल नहीं हुआ है।
- मॉडल मेल नहीं खाता: प्रीव्यू टास्क का AI मॉडल अनुरोधित refine मॉडल के साथ असंगत है।
- remove_lighting के लिए असमर्थित मॉडल: remove_lighting, ai_model: "meshy-6-lite" के साथ सेट किया गया है।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जांचें।
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

# 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

Text to 3D टास्क को प्राप्त करें

यह एंडपॉइंट आपको किसी मान्य टास्क id के आधार पर Text to 3D टास्क प्राप्त करने की अनुमति देता है। Text to 3D टास्क ऑब्जेक्ट में शामिल properties देखने के लिए The Text to 3D Task Object देखें।

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

पैरामीटर

Name
id
Type
path
Description
प्राप्त किए जाने वाले Text to 3D टास्क के लिए यूनीक पहचानकर्ता।

रिटर्न

रिस्पॉन्स में Text to 3D टास्क ऑब्जेक्ट शामिल होता है। विवरण के लिए The Text to 3D Task Object सेक्शन देखें।

उदाहरण

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

Text to 3D टास्क डिलीट करें

यह एंडपॉइंट किसी Text to 3D टास्क को स्थायी रूप से डिलीट कर देता है, जिसमें उससे जुड़े सभी मॉडल और डेटा भी शामिल हैं। यह कार्रवाई अपरिवर्तनीय (irreversible) है।

पाथ पैरामीटर

Name
id
Type
path
Description
डिलीट किए जाने वाले Text to 3D टास्क की ID।

टास्क स्टेटस

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

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

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

रिटर्न

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

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 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/v2/text-to-3d

List Text to 3D Tasks

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

पैरामीटर

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

रिटर्न

द टेक्स्ट टू 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

एक Text to 3D टास्क को स्ट्रीम करें

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

पैरामीटर

Name
id
Type
path
Description
स्ट्रीम करने के लिए Text to 3D टास्क का यूनीक आइडेंटिफायर।

रिटर्न वैल्यू

The Text to 3D Task Objects की एक स्ट्रीम Server-Sent Events के रूप में रिटर्न करता है।

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
}

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

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

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

प्रॉपर्टीज़

Name
id
Type
string
Description
टास्क के लिए यूनीक आइडेंटिफायर। हालांकि हम इम्प्लीमेंटेशन डिटेल के रूप में टास्क आईडी के लिए k-sortable UUID का उपयोग करते हैं, आपको आईडी के फॉर्मेट के बारे में कोई भी धारणा नहीं बनानी चाहिए।
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
डेप्रिकेटेड; इसके बजाय geometry_resolution पढ़ें।
Name
geometry_resolution
Type
string
Description
Ultra टियर जिस पर preview टास्क चला (2k या 4k); standard के लिए छोड़ दिया जाता है।
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
टास्क की progress। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 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
टास्क से जनरेट किए गए टेक्सचर URL ऑब्जेक्ट्स की एक array। सामान्यतः इसमें केवल एक टेक्सचर 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-6-lite, meshy-7.1, या latest है, या यदि टास्क ai_model सेट किए बिना किसी meshy-t2 preview को refine करता है, तो इस प्रॉपर्टी को छोड़ दिया जाएगा।
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
}