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

अपनी खुद की एप्लिकेशन में टेक्स्ट प्रॉम्प्ट से 3D मॉडल जनरेट करें।

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

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

Text to 3D preview टास्क बनाएँ

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

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

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"
}

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
दो-चरण वर्कफ़्लो का चरण। preview टास्क बनाने के लिए preview भेजें।
Name
prompt
Type
string
आवश्यक
Description
जनरेट किए जाने वाले ऑब्जेक्ट का वर्णन करने वाला टेक्स्ट, अधिकतम 800 अक्षर तक। इससे लंबा टेक्स्ट 400 लौटाता है।
Name
model_type
Type
string
डिफ़ॉल्ट standard
Description
जनरेट किए जाने वाले 3D मेश का प्रकार।
उपलब्ध मान:
- standard: एक उच्च-डिटेल वाला 3D मेश
- smart-topology: एक Smart Topology मेश। ai_model (meshy-t2 या meshy-t2.5) के साथ मॉडल चुनें।
smart-topology के साथ, Meshy should_remesh और decimation_mode को नज़रअंदाज़ करता है, और केवल topology: triangle स्वीकार करता है।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
वह AI मॉडल जो 3D मॉडल जनरेट करता है। उपलब्ध मान model_type पर निर्भर करते हैं।
Standard मॉडल (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: अधिक स्वच्छ topology, स्वाभाविक रूप से अलग किए गए पार्ट्स, triangle आउटपुट, और एक फेस काउंट जो आप target_polycount से सेट करते हैं
- meshy-t2.5 (डिफ़ॉल्ट): गेम असेट्स के लिए अधिक तीखी डिटेल, triangle आउटपुट, और एक फेस काउंट जो आप target_polycount से सेट करते हैं
Name
geometry_resolution
Type
string
डिफ़ॉल्ट standard
Description
ज्यामिति जनरेशन पास। यह केवल preview टास्क पर लागू होता है। इस पैरामीटर के साथ एक refine 400 लौटाता है।
उपलब्ध मान:
- standard
- 2k: Ultra पास को 2048³ पर चलाता है
- 4k: Ultra पास को 4096³ पर चलाता है, अधिक बारीक सरफेस डिटेल के लिए
2k को meshy-7.1, latest, या डेप्रिकेटेड meshy-7 की ज़रूरत होती है। 4k को meshy-7.1 या latest की ज़रूरत होती है। अन्य मॉडल 400 लौटाते हैं।
Name
ultra_mode
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय geometry_resolution भेजें। ultra_mode: true, geometry_resolution: "2k" के समान है।
Name
should_remesh
Type
boolean
डिफ़ॉल्ट true (meshy-6-lite), false (other models)
Description
जनरेशन के बाद मॉडल को रीमेश करना है या नहीं। सबसे उच्च-गुणवत्ता वाले 3D मॉडल के लिए, false भेजें।

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

Name
topology
Type
string
डिफ़ॉल्ट triangle
Description
रीमेश किए गए मॉडल का फेस प्रकार।
उपलब्ध मान:
- quad: एक quad-प्रधान मेश
- triangle: एक डेसिमेटेड triangle मेश
Smart Topology आउटपुट केवल triangle होता है। ai_model meshy-t2 या meshy-t2.5 के साथ quad भेजने पर 400 लौटता है।
Name
decimation_mode
Type
integer
Description
लेवल के अनुसार एडैप्टिव फेस काउंट। जब आप इसे सेट करते हैं, तो Meshy target_polycount को नज़रअंदाज़ करता है।
उपलब्ध मान:
- 1: ultra
- 2: high
- 3: medium
- 4: low

Name
target_polycount
Type
integer
Description
हासिल किए जाने वाले फेस की संख्या। ज्यामिति के आधार पर परिणाम लक्ष्य से अलग हो सकता है। यह दो अलग-अलग मामलों में लागू होता है:
- रीमेश: एक standard मॉडल पर should_remesh: true के साथ। Meshy मेश को लगभग इस काउंट तक रीमेश (डेसिमेट) करता है। यदि आप decimation_mode सेट करते हैं, तो Meshy उसका उपयोग करता है और target_polycount को नज़रअंदाज़ करता है।
- Smart Topology: model_type: smart-topology और ai_model meshy-t2 या meshy-t2.5 के साथ। Meshy मॉडल को सीधे इस फेस काउंट पर जनरेट करता है। कोई रीमेश नहीं चलता, और आपको should_remesh की ज़रूरत नहीं है।
निम्न तालिका प्रत्येक मामले के लिए रेंज और डिफ़ॉल्ट दिखाती है:
मामला रेंज डिफ़ॉल्ट
रीमेश 100 से 300000 30000
meshy-t2 100 से 15000 4000
meshy-t2.5 100 से 30000 15000
रेंज से बाहर का मान 400 लौटाता है।

मामला	रेंज	डिफ़ॉल्ट
रीमेश	`100` से `300000`	`30000`
`meshy-t2`	`100` से `15000`	`4000`
`meshy-t2.5`	`100` से `30000`	`15000`

Name
symmetry_mode
Type
string
⚠ पुराना
डिफ़ॉल्ट auto
Description
इसे छोड़ दें। यह पैरामीटर आउटपुट को प्रभावित नहीं करता है।
उपलब्ध मान:
- off: सममिति को अक्षम करता है
- auto: इनपुट ज्यामिति के आधार पर सममिति लागू करता है
- on: जनरेशन के दौरान सममिति को लागू करता है
Name
pose_mode
Type
string
डिफ़ॉल्ट ""
Description
जनरेट किए गए मॉडल की पोज़।
उपलब्ध मान:
- 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 इसे नज़रअंदाज़ करता है।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
जनरेट करने से पहले prompt में हानिकारक सामग्री की जांच करनी है या नहीं। यदि Meshy को हानिकारक सामग्री मिलती है, तो रिक्वेस्ट 400 लौटाती है और Meshy कोई टास्क नहीं बनाता।
Name
target_formats
Type
string[]
Description
जनरेट किए जाने वाले फ़ाइल फ़ॉर्मेट। Meshy केवल इन फ़ॉर्मेट को जनरेट और रिटर्न करता है, जिससे टास्क छोटा हो सकता है। यदि आप इसे छोड़ देते हैं, तो Meshy 3mf को छोड़कर हर फ़ॉर्मेट जनरेट करता है, जिसे वह केवल तभी जनरेट करता है जब आप इसका अनुरोध करते हैं।
उपलब्ध मान:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
एक पारदर्शी बैकग्राउंड (RGBA) के साथ भी एक preview रेंडर करना है या नहीं, जो टास्क प्राप्त करने पर alpha_thumbnail_url में लौटाया जाता है। thumbnail_url नहीं बदलता।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
AI विज़न से ऑब्जेक्ट की वास्तविक-दुनिया की ऊंचाई का अनुमान लगाकर मॉडल को उसके अनुसार रीसाइज़ करना है या नहीं। जब तक आप origin_at सेट नहीं करते, Meshy ओरिजिन को नीचे रखता है।

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

Name
origin_at
Type
string
डिफ़ॉल्ट bottom
Description
मॉडल का ओरिजिन कहाँ रखें, bottom या center।

रिटर्न

रिस्पॉन्स का result फ़ील्ड नए Text to 3D टास्क का ID रखता है।

फ़ेल्योर मोड

Name
400 - Bad Request
Description
रिक्वेस्ट नहीं चल सकती। एरर मैसेज बताता है कि कौन सी समस्या मिली। उदाहरण के लिए:
- पैरामीटर गायब है: एक आवश्यक पैरामीटर, जैसे prompt या mode, गायब है।
- Prompt बहुत लंबा है: prompt अक्षर सीमा से अधिक है।
- Ultra के लिए असमर्थित मॉडल: geometry_resolution, 2k या 4k है, एक ऐसे ai_model के साथ जो इसे नहीं चला सकता।
रिक्वेस्ट को ठीक करें, फिर इसे फिर से भेजें। देखें Errors।
Name
401 - Unauthorized
Description
API की गायब है या अमान्य है। Authorization हेडर जांचें।
Name
402 - Payment Required
Description
उदाहरण के लिए:
- अपर्याप्त क्रेडिट: इस टास्क के लिए अकाउंट में पर्याप्त क्रेडिट नहीं है, या अकाउंट क्रेडिट सीमा तक पहुँच गया है। अपना क्रेडिट बैलेंस जांचें, फिर फिर से प्रयास करें।
- फ्री प्लान: टास्क बनाने के लिए एक पेड प्लान की आवश्यकता होती है। अपने सब्सक्रिप्शन सेटिंग्स में अपना प्लान अपग्रेड करें, फिर फिर से प्रयास करें।
Name
403 - Forbidden
Description
Content moderation ने prompt या किसी इनपुट इमेज को ब्लॉक कर दिया। इनपुट बदलें, फिर फिर से प्रयास करें।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है। प्रतीक्षा करें, फिर फिर से प्रयास करें। देखें Rate limits।

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

टेक्स्ट से 3D refine टास्क बनाना

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

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

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
}'

# Refine with Meshy N1 from the preview's stored reference image
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",
  "ai_model": "meshy-n1"
}'

Response

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

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
टू-स्टेप वर्कफ़्लो का चरण। refine टास्क बनाने के लिए refine भेजें।
Name
preview_task_id
Type
string
आवश्यक
Description
टेक्सचर करने के लिए प्रीव्यू टास्क की ID। प्रीव्यू टास्क की स्थिति SUCCEEDED होनी चाहिए।
Name
enable_pbr
Type
boolean
डिफ़ॉल्ट false
Description
बेस कलर के साथ PBR मैप (metallic, roughness, और normal) भी जनरेट करना है या नहीं।
ai_model meshy-6 के साथ, Meshy एक emission map भी जनरेट करता है, सिवाय texture_resolution: 8k के। meshy-6-lite, meshy-7, meshy-7.1, और latest emission map जनरेट नहीं करते। न ही meshy-t2 या meshy-t2.5 प्रीव्यू के refine में ऐसा होता है जो ai_model सेट नहीं करता। ai_model: meshy-n1 के साथ, true 400 रिटर्न करता है।
Name
texture_resolution
Type
string
डिफ़ॉल्ट 2k
Description
बेस कलर टेक्सचर का रिज़ॉल्यूशन। यह केवल refine टास्क पर लागू होता है। इस पैरामीटर के साथ एक प्रीव्यू 400 रिटर्न करता है।
उपलब्ध वैल्यूज़:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
उच्च रिज़ॉल्यूशन अधिक सरफेस डिटेल कैप्चर करते हैं। 4k और 8k को ai_model meshy-6, meshy-7.1, या latest चाहिए। meshy-n1 के साथ, ये 400 रिटर्न करते हैं। 8k पर, Meshy emission map जनरेट नहीं करता।
Name
hd_texture
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय texture_resolution भेजें। hd_texture: true, texture_resolution: "4k" के समान है। यदि आप दोनों भेजते हैं, तो Meshy texture_resolution का उपयोग करता है।
Name
texture_prompt
Type
string
Description
टेक्सचरिंग को गाइड करने वाला टेक्स्ट, 800 अक्षरों तक। इससे लंबा टेक्स्ट 400 रिटर्न करता है। texture_prompt या texture_image_url भेजें, दोनों नहीं। यदि आप दोनों भेजते हैं, तो Meshy texture_prompt का उपयोग करता है। ai_model: meshy-n1 के साथ, इसे भेजने पर 400 रिटर्न होता है।
Name
texture_image_url
Type
string
Description
टेक्सचरिंग को गाइड करने वाली एक 2D इमेज, एक पब्लिक URL या बेस64-एन्कोडेड डेटा URI के रूप में, जैसे data:image/jpeg;base64,<your base64-encoded image data>।
इमेज अधिकतम 20 MB की .jpg, .jpeg, .png, या .webp फ़ाइल होनी चाहिए, जिसके प्रत्येक साइड पर कम से कम 32 पिक्सेल और अधिकतम 178,956,970 पिक्सेल (चौड़ाई × ऊँचाई) हों।
ai_model: meshy-n1 के साथ, Meshy इस इमेज को फ्रंट व्यू के रूप में टेक्सचर करता है।
जब इमेज में आकार मॉडल से बहुत अलग हो, तो इमेज से टेक्सचरिंग अच्छी तरह से काम नहीं कर सकती है।
Name
ai_model
Type
string
डिफ़ॉल्ट inherited from the preview task
Description
वह AI मॉडल जो मेश को टेक्सचर करता है।
उपलब्ध वैल्यूज़:
- meshy-6-lite
- meshy-6
- meshy-7.1
- latest: Meshy 7.1
- meshy-n1: केवल एक रेफरेंस इमेज से 2K बेस कलर टेक्सचर। कोई टेक्स्ट prompt नहीं, कोई PBR मैप नहीं, कोई 4K या 8K नहीं।
- meshy-7 (डेप्रिकेटेड): इसके बजाय meshy-7.1 भेजें
प्रीव्यू टास्क के मॉडल का उपयोग करने के लिए इसे छोड़ दें, ताकि प्रीव्यू और उसका refine एंड टू एंड एक ही मॉडल पर चलें। इसे ओवरराइड करने के लिए एक वैल्यू भेजें। एक स्पष्ट latest उसी तरह से रिज़ॉल्व होता है जैसे प्रीव्यू टास्क पर होता है, इसलिए एक latest प्रीव्यू और उसका latest refine हमेशा एक ही टेक्सचर मॉडल का उपयोग करते हैं।
meshy-n1 के साथ, Meshy texture_image_url से टेक्सचर करता है। इसके बिना, Meshy उस रेफरेंस इमेज का उपयोग करता है जिसे meshy-7.1 या latest प्रीव्यू स्टोर करता है। कोई भी अन्य प्रीव्यू 400 रिटर्न करता है जब तक आप texture_image_url न भेजें। प्रीव्यू में अधिकतम 7,999,999 ट्रायंगल हो सकते हैं। क्वाड्स में remesh किया गया प्रीव्यू 400 रिटर्न करता है।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
जनरेट करने से पहले texture_prompt और texture_image_url को हानिकारक सामग्री के लिए स्क्रीन करना है या नहीं। यदि Meshy हानिकारक सामग्री का पता लगाता है, तो रिक्वेस्ट 400 रिटर्न करती है और Meshy टास्क नहीं बनाता।
Name
remove_lighting
Type
boolean
डिफ़ॉल्ट true
Description
बेस कलर टेक्सचर से हाइलाइट्स और शैडो हटाना है या नहीं। क्लीनर परिणाम कस्टम लाइटिंग के तहत बेहतर काम करता है।
यह केवल तभी प्रभावी होता है जब ai_model, meshy-6 हो। meshy-7.1 और latest इसे स्वीकार करते हैं और इसे नज़रअंदाज़ करते हैं, और meshy-t2 या meshy-t2.5 प्रीव्यू के refine में भी ऐसा ही होता है जो ai_model सेट नहीं करता। meshy-6-lite के साथ इसे भेजने पर 400 रिटर्न होता है। meshy-n1 के साथ, true 400 रिटर्न करता है।
Name
target_formats
Type
string[]
Description
जनरेट करने के लिए फ़ाइल फॉर्मैट। Meshy केवल इन फॉर्मैट को जनरेट और रिटर्न करता है, जिससे टास्क छोटा हो सकता है। यदि आप इसे छोड़ देते हैं, तो Meshy 3mf को छोड़कर हर फॉर्मैट जनरेट करता है, जिसे वह केवल तब जनरेट करता है जब आप इसका अनुरोध करते हैं।
उपलब्ध वैल्यूज़:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
पारदर्शी बैकग्राउंड (RGBA) के साथ एक प्रीव्यू भी रेंडर करना है या नहीं, जो टास्क प्राप्त करते समय alpha_thumbnail_url में रिटर्न होता है। thumbnail_url नहीं बदलता।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
AI विज़न के साथ ऑब्जेक्ट की वास्तविक-दुनिया की ऊंचाई का अनुमान लगाना है और मॉडल को उसके अनुसार रीसाइज़ करना है या नहीं। जब तक आप origin_at सेट नहीं करते, Meshy ओरिजिन को नीचे रखता है।

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

Name
origin_at
Type
string
डिफ़ॉल्ट bottom
Description
मॉडल का ओरिजिन कहाँ रखा जाए, 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" के साथ भेजा गया था।
- Meshy N1 के लिए कोई रेफरेंस इमेज नहीं: ai_model: meshy-n1 को texture_image_url के बिना भेजा गया था, और प्रीव्यू में ऐसी कोई रेफरेंस इमेज नहीं है जिसे Meshy N1 उपयोग कर सके। texture_image_url भेजें।
- Meshy N1 के लिए क्वाड प्रीव्यू: ai_model: meshy-n1 को एक ऐसे प्रीव्यू के लिए भेजा गया था जिसे क्वाड्स में remesh किया गया है। इसे किसी अन्य ai_model के साथ refine करें।
- Meshy N1 के लिए बहुत अधिक ट्रायंगल: ai_model: meshy-n1 के साथ, प्रीव्यू में 7,999,999 से अधिक ट्रायंगल हैं। इसे किसी अन्य ai_model के साथ refine करें।
- Meshy N1 के लिए असमर्थित विकल्प: ai_model: meshy-n1 को इनमें से किसी एक विकल्प के साथ भेजा गया था:
  - texture_prompt
  - enable_pbr: true
  - 4k या 8k का texture_resolution
  - texture_resolution के बिना hd_texture: true
  - remove_lighting: true
रिक्वेस्ट ठीक करें, फिर इसे दोबारा भेजें। देखें एरर।
Name
401 - Unauthorized
Description
API की गायब है या अमान्य है। Authorization हेडर जांचें।
Name
402 - Payment Required
Description
उदाहरण के लिए:
- अपर्याप्त क्रेडिट: अकाउंट के पास इस टास्क के लिए पर्याप्त क्रेडिट नहीं हैं, या अकाउंट क्रेडिट लिमिट तक पहुंच गया है। अपना क्रेडिट बैलेंस जांचें, फिर पुनः प्रयास करें।
- फ्री प्लान: टास्क बनाने के लिए पेड प्लान की आवश्यकता होती है। अपने सब्सक्रिप्शन सेटिंग्स में अपना प्लान अपग्रेड करें, फिर पुनः प्रयास करें।
Name
403 - Forbidden
Description
कंटेंट moderation ने prompt या इनपुट इमेज को ब्लॉक कर दिया। इनपुट बदलें, फिर पुनः प्रयास करें।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है। प्रतीक्षा करें, फिर पुनः प्रयास करें। देखें रेट लिमिट।

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

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

यह किसी टेक्स्ट से 3D टास्क को उसकी ID के माध्यम से लौटाता है। यह 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": null,

  "consumed_credits": 20
}

पैरामीटर

Name
id
Type
path
Description
क्रिएट रिस्पॉन्स से प्राप्त टास्क ID।

रिटर्न

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

उदाहरण

निम्नलिखित तालिका प्रत्येक mode के लिए एक नमूना मॉडल दर्शाती है।

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

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

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

किसी Text to 3D टास्क को उसके मॉडलों और डेटा सहित स्थायी रूप से डिलीट कर देता है। आप डिलीट को पूर्ववत नहीं कर सकते।

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 keeps 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."
}

पाथ पैरामीटर

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

टास्क स्टेटस

किसी PENDING टास्क को डिलीट करने पर उसे बनाते समय इस्तेमाल हुए क्रेडिट वापस मिल जाते हैं।

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

फ़ाइनल स्टेटस (SUCCEEDED, FAILED, या CANCELED) वाले टास्क को डिलीट करने पर उसके क्रेडिट वापस नहीं मिलते।

रिटर्न

टास्क डिलीट होने पर 200 OK, या टास्क IN_PROGRESS होने पर 409 Conflict।

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

Text to 3D टास्क की सूची

यह आपके Text to 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": null,

    "consumed_credits": 20
  }
]

पैरामीटर

Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
वापस किया जाने वाला पेज नंबर, अधिकतम 255। इससे बड़ा मान 400 लौटाएगा।
Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
प्रति पेज टास्क की संख्या, अधिकतम 100।
Name
sort_by
Type
string
Description
सॉर्ट ऑर्डर।
उपलब्ध मान:
- +created_at: सबसे पुराना पहले
- -created_at: सबसे नया पहले

रिटर्न

Text to 3D टास्क ऑब्जेक्ट की एक पेजिनेटेड सूची।

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

Stream a Text to 3D task

किसी टेक्स्ट से 3D टास्क के अपडेट्स को सर्वर-सेंट इवेंट्स (SSE) के रूप में स्ट्रीम करता है।

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.
// These examples are shortened. Each event holds the full task object.
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": null,

"consumed_credits": 20
}

Parameters

Name
id
Type
path
Description
क्रिएट रिस्पॉन्स से प्राप्त टास्क ID।

Returns

टेक्स्ट से 3D टास्क ऑब्जेक्ट्स की एक स्ट्रीम, सर्वर-सेंट इवेंट्स के रूप में।

प्रत्येक इवेंट में पूरा टास्क ऑब्जेक्ट होता है, उसी आकार में जो Get एंडपॉइंट रिटर्न करता है। जब तक टास्क PENDING या IN_PROGRESS स्थिति में है, तब तक इसके रिज़ल्ट फ़ील्ड्स में कोई वैल्यू नहीं होती।

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

एक टेक्स्ट से 3D टास्क ऑब्जेक्ट एक ऐसे टास्क का वर्णन करता है जो एक टेक्स्ट prompt से 3D मॉडल जनरेट करता है। यह स्टेटस, progress, और टास्क सफल होने पर मॉडल फ़ाइलों को होल्ड करता है। टेक्स्ट से 3D के दो चरण होते हैं, preview और refine। एक preview टास्क केवल-मेश 3D मॉडल जनरेट करता है, और एक refine टास्क preview के परिणाम से एक टेक्सचर्ड 3D मॉडल जनरेट करता है।

Properties

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": null,

  "consumed_credits": 20
}

Name
id
Type
string
Description
टास्क ID। इसे एक ऑपेक स्ट्रिंग मानें, और इसके फॉर्मेट पर निर्भर न रहें।
Name
type
Type
string
Description
टास्क का प्रकार, preview टास्क के लिए text-to-3d-preview या refine टास्क के लिए text-to-3d-refine।
Name
model_urls
Type
object
Description
जनरेट किए गए 3D मॉडल के लिए डाउनलोड URL, प्रति फ़ाइल फॉर्मेट एक। जिस फॉर्मेट को टास्क ने जनरेट नहीं किया है, उसकी कोई key नहीं होती, खाली स्ट्रिंग के बजाय।
- Name
  glb
  Type
  string
  Description
  GLB फ़ाइल।
- Name
  fbx
  Type
  string
  Description
  FBX फ़ाइल।
- Name
  usdz
  Type
  string
  Description
  USDZ फ़ाइल।
- Name
  obj
  Type
  string
  Description
  OBJ फ़ाइल।
- Name
  mtl
  Type
  string
  Description
  MTL फ़ाइल।
- Name
  stl
  Type
  string
  Description
  STL फ़ाइल।
- Name
  3mf
  Type
  string
  Description
  3MF फ़ाइल। केवल तभी मौजूद होती है जब target_formats में 3mf शामिल हो।
Name
prompt
Type
string
Description
वह prompt जो आपने टास्क बनाने के लिए भेजा था, अपरिवर्तित।
Name
texture_prompt
Type
string
Description
वह टेक्स्ट prompt जो आपने refine चरण में टेक्सचरिंग को गाइड करने के लिए भेजा था।
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
3D मॉडल की थंबनेल इमेज के लिए डाउनलोड URL।
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url के एक ऐसे संस्करण के लिए डाउनलोड URL जिसमें पारदर्शी बैकग्राउंड (RGBA) हो। केवल तभी मौजूद होता है जब आपने alpha_thumbnail: true के साथ टास्क बनाया हो और Meshy ने पारदर्शी preview रेंडर किया हो।
Name
progress
Type
integer
Description
टास्क कितना पूरा हुआ है, प्रतिशत के रूप में। टास्क शुरू होने तक यह 0 रहता है और सफल होने पर 100 हो जाता है।
Name
started_at
Type
timestamp
Description
वह समय जब टास्क शुरू हुआ, Unix मिलीसेकंड में। टास्क शुरू होने तक यह 0 रहता है।
Name
created_at
Type
timestamp
Description
वह समय जब टास्क बनाया गया, Unix मिलीसेकंड में।
Name
finished_at
Type
timestamp
Description
वह समय जब टास्क समाप्त हुआ, Unix मिलीसेकंड में। टास्क समाप्त होने तक यह 0 रहता है।
Name
status
Type
string
Description
टास्क का स्टेटस, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, या CANCELED में से एक।
Name
texture_urls
Type
array
Description
जनरेट किए गए टेक्सचर मैप्स के लिए डाउनलोड URL, ऑब्जेक्ट्स के ऐरे के रूप में। इसमें आमतौर पर एक ऑब्जेक्ट होता है। प्रत्येक ऑब्जेक्ट में ये फ़ील्ड होते हैं:
- Name
  base_color
  Type
  string
  Description
  बेस कलर मैप।
- Name
  metallic
  Type
  string
  Description
  मेटैलिक मैप। आपके द्वारा enable_pbr: false के साथ टास्क बनाने पर अनुपस्थित होता है।
- Name
  normal
  Type
  string
  Description
  नॉर्मल मैप। आपके द्वारा enable_pbr: false के साथ टास्क बनाने पर अनुपस्थित होता है।
- Name
  roughness
  Type
  string
  Description
  रफनेस मैप। आपके द्वारा enable_pbr: false के साथ टास्क बनाने पर अनुपस्थित होता है।
- Name
  emission
  Type
  string
  Description
  एमिशन मैप। इनमें से किसी भी स्थिति में अनुपस्थित होता है:
  
  आपने टास्क enable_pbr: false के साथ बनाया हो।
  
  ai_model, meshy-6-lite, meshy-7, meshy-7.1, या latest हो।
  
  texture_resolution, 8k हो।
  
  टास्क ai_model सेट किए बिना किसी meshy-t2 या meshy-t2.5 preview को refine करता हो।
Name
preceding_tasks
Type
integer
Description
क्यू में इस टास्क से आगे मौजूद टास्क की संख्या। यह मान केवल तभी सार्थक होता है जब टास्क PENDING स्थिति में हो।
Name
task_error
Type
object
Description
टास्क विफल होने पर एरर का विवरण। जब तक स्टेटस FAILED न हो, यह null रहता है। देखें एरर।
Name
consumed_credits
Type
integer
Description
टास्क द्वारा उपयोग किए गए क्रेडिट की संख्या। स्टेटस PENDING, IN_PROGRESS, या SUCCEEDED होने पर मौजूद होती है। FAILED टास्क के लिए यह 0 होती है, क्योंकि टास्क विफल होने पर Meshy क्रेडिट वापस कर देता है।