रीटेक्सचर API
किसी मौजूदा 3D मॉडल के लिए टेक्स्ट prompt या रेफरेंस इमेज से नई टेक्सचर जनरेट करें। मॉडल किसी अन्य Meshy टास्क से या किसी मॉडल फ़ाइल से आ सकता है।
Retexture टास्क बनाएं
एक Retexture टास्क बनाता है। टास्क बैकग्राउंड में चलता है। एक टास्क में आम तौर पर कितना समय लगता है, यह जानने के लिए Processing times देखें।
Request
# Retexture with text prompt
curl https://api.meshy.ai/openapi/v1/retexture \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
"text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
"enable_original_uv": true,
"enable_pbr": true
}'
# Retexture with image style and PBR
curl https://api.meshy.ai/openapi/v1/retexture \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
"image_style_url": "<your publicly accessible image url or base64-encoded data URI>",
"ai_model": "latest",
"enable_pbr": true,
"enable_original_uv": true
}'
# Retexture with Meshy N1 from front and back views
curl https://api.meshy.ai/openapi/v1/retexture \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
"ai_model": "meshy-n1",
"multiview_image_urls": [
"<your front view image url or data URI>",
"<your back view image url or data URI>"
]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
पैरामीटर
- Name
- input_task_id
- Type
- string
- आवश्यक
- Description
आवश्यक है जब तक आप
model_urlन भेजें। उस टास्क की ID जिसने टेक्सचर करने के लिए एक 3D मॉडल बनाया, उदाहरण के लिए एक टेक्स्ट से 3D, इमेज से 3D, रीमेश, या रीटेक्सचर टास्क। टास्क वही होना चाहिए जिसे आपने API से बनाया था और जिसकी स्थितिSUCCEEDEDहै। Meshy टास्क के GLB को टेक्सचर करता है।meshy-n1के साथ, टास्क के मॉडल में अधिकतम 7,999,999 फेस हो सकते हैं, जिन्हें त्रिभुज के रूप में गिना जाता है (एक क्वाड को 2 के रूप में गिना जाता है)।
- Name
- model_url
- Type
- string
- आवश्यक
- Description
आवश्यक है जब तक आप
input_task_idन भेजें। टेक्सचर करने के लिए मॉडल, एक सार्वजनिक URL या एक data URI के रूप में। यदि आप दोनों भेजते हैं, तो Meshyinput_task_idका उपयोग करता है।मॉडल एक GLB, glTF, OBJ, FBX, या STL फ़ाइल होनी चाहिए, जो
httpयाhttpsURL से अधिकतम 400 MB की हो, या data URI के रूप में 100 MB की हो। data URI के लिए, MIME typeapplication/octet-streamका उपयोग करें, उदाहरण के लिएdata:application/octet-stream;base64,<your base64-encoded model data>।100 MB से बड़ी फ़ाइल को इन नियमों का भी पालन करना चाहिए:
- एक GLB, glTF, FBX, या OBJ फ़ाइल में अधिकतम 10,000,000 फेस हो सकते हैं। Meshy फेस को त्रिभुज के रूप में गिनता है, इसलिए एक क्वाड को 2 के रूप में गिना जाता है, और एक से अधिक बार बनाए गए मेश को प्रत्येक कॉपी के लिए एक बार गिना जाता है।
- एक FBX फ़ाइल बाइनरी FBX 7.1 या उससे नई होनी चाहिए।
- एक GLB या glTF फ़ाइल में Draco कम्प्रेशन का उपयोग नहीं होना चाहिए।
meshy-n1के साथ, मॉडल में अधिकतम 7,999,999 फेस हो सकते हैं, जिन्हें त्रिभुज के रूप में गिना जाता है (एक क्वाड को 2 के रूप में गिना जाता है), चाहे उसका फ़ाइल आकार कुछ भी हो।
इन तीन स्टाइल इनपुट में से एक भेजें।
- Name
- text_style_prompt
- Type
- string
- आवश्यक
- Description
आवश्यक है जब तक आप
image_style_urlयाmultiview_image_urlsन भेजें। वह टेक्स्ट जो आपके वांछित टेक्सचर का वर्णन करता है, अधिकतम 800 अक्षर तक। इससे लंबा टेक्स्ट400लौटाता है।meshy-n1के साथ, इसेimage_style_urlके बिना भेजने पर400लौटता है।
- Name
- image_style_url
- Type
- string
- आवश्यक
- Description
आवश्यक है जब तक आप
text_style_promptयाmultiview_image_urlsन भेजें। एक 2D इमेज जिसकी स्टाइल को टेक्सचर फॉलो करता है, एक सार्वजनिक URL या data URI (data:image/jpeg;base64,<your base64-encoded image data>) के रूप में। यदि आपtext_style_promptऔरimage_style_urlदोनों भेजते हैं, तो Meshyimage_style_urlका उपयोग करता है।इमेज एक
.jpg,.jpeg,.png, या.webpफ़ाइल होनी चाहिए, जो अधिकतम 20 MB की हो, और प्रत्येक तरफ कम से कम 32 पिक्सल की हो।जब इमेज में ऑब्जेक्ट का आकार मॉडल से बहुत अलग हो, तो टेक्सचर अच्छी तरह फिट नहीं हो सकता।
meshy-n1के साथ, Meshy इमेज को फ्रंट व्यू के रूप में मानता है।
- Name
- multiview_image_urls
- Type
- string[]
- आवश्यक
- Description
आवश्यक है जब तक आप
text_style_promptयाimage_style_urlन भेजें। एक ही ऑब्जेक्ट की अलग-अलग व्यू की एक से चार इमेज। पहली इमेज मुख्य (फ्रंट) व्यू है। अन्य व्यू (बाएं, पीछे, दाएं) का क्रम मायने नहीं रखता। एक खाली array, या चार से अधिक इमेज,400लौटाता है।प्रत्येक इमेज
image_style_urlके समान फॉर्मेट और आकार नियमों का पालन करती है, प्रति इमेज अधिकतम 20 MB। आपmultiview_image_urlsकोtext_style_promptयाimage_style_urlके साथ जोड़ नहीं सकते।multiview_image_urlsकोmeshy-7याmeshy-n1का स्पष्टai_modelचाहिए। कोई भी अन्यai_model, जिसमें डिफ़ॉल्टlatestशामिल है,400लौटाता है।
- Name
- ai_model
- Type
- string
- डिफ़ॉल्ट latest
- Description
AI मॉडल जो टेक्सचर जनरेट करता है।
उपलब्ध मान:
meshy-6-litemeshy-6meshy-7meshy-n1: केवल संदर्भ इमेज से 2K बेस कलर टेक्सचर। कोई टेक्स्ट prompt नहीं, कोई PBR मैप नहीं, कोई 4K या 8K नहीं। अधिकतम 7,999,999 फेस।latest: Meshy 7
- Name
- enable_original_uv
- Type
- boolean
- डिफ़ॉल्ट false
- Description
नया UV लेआउट जनरेट करने के बजाय मॉडल का UV लेआउट बनाए रखना है या नहीं।
- Meshy द्वारा जनरेट किए गए मॉडल के लिए,
input_task_idसे या ऐसेmodel_urlसे जो Meshy आउटपुट को इंगित करता है, इसके ऑप्टिमाइज़्ड UV लेआउट को फिर से उपयोग करने के लिएtrueका उपयोग करें। - कहीं और से अपलोड किए गए मॉडल के लिए, पहले से अच्छे UV बनाए रखने के लिए
trueका उपयोग करें। इसेfalseछोड़ दें ताकि Meshy नए UV जनरेट करे, जो उस मॉडल के लिए उपयुक्त है जिसमें उचित UV मैपिंग नहीं है।
- Meshy द्वारा जनरेट किए गए मॉडल के लिए,
- Name
- enable_pbr
- Type
- boolean
- डिफ़ॉल्ट false
- Description
क्या बेस कलर के साथ PBR मैप (मेटैलिक, रफनेस, और नॉर्मल) भी जनरेट करने हैं।
meshy-6के साथ, Meshy एक एमिशन मैप भी जनरेट करता है, सिवाय8kकेtexture_resolutionपर।meshy-6-lite,meshy-7, औरlatestएमिशन मैप जनरेट नहीं करते।meshy-n1के साथ,true400लौटाता है।
- Name
- texture_resolution
- Type
- string
- डिफ़ॉल्ट 2k
- Description
बेस कलर टेक्सचर का आकार। उच्च रेजोल्यूशन अधिक सतह विवरण कैप्चर करते हैं।
उपलब्ध मान:
2k: 2048 × 2048 पिक्सल4k: 4096 × 4096 पिक्सल8k: 8192 × 8192 पिक्सल
4kऔर8kकोmeshy-6,meshy-7, याlatestकेai_modelकी आवश्यकता होती है।meshy-6-liteयाmeshy-n1के साथ, वे400लौटाते हैं।8kपर, Meshy एमिशन मैप जनरेट नहीं करता।
- Name
- hd_texture
- Type
- boolean
- ⚠ पुराना
- डिफ़ॉल्ट false
- Description
इसके बजाय
texture_resolutionका उपयोग करें।true,texture_resolution: "4k"के समान है। यदि आप दोनों भेजते हैं, तो Meshytexture_resolutionका उपयोग करता है।
- Name
- remove_lighting
- Type
- boolean
- डिफ़ॉल्ट true
- Description
बेस कलर टेक्सचर से हाइलाइट्स और शैडो हटाने हैं या नहीं। परिणाम आपकी अपनी लाइटिंग के तहत बेहतर काम करता है।
Meshy इसे केवल
meshy-6के साथ लागू करता है,2kया4kकेtexture_resolutionपर।meshy-7याlatestके साथ, या8kपर, Meshy इसे स्वीकार करता है और इसे अनदेखा करता है।meshy-6-liteयाmeshy-n1के साथ, इसे किसी भी मान के साथ भेजने पर400लौटता है।
- Name
- target_formats
- Type
- string[]
- Description
जनरेट करने के लिए फ़ाइल फॉर्मेट। Meshy केवल वही फॉर्मेट जनरेट करता है जो आप सूचीबद्ध करते हैं, जो टास्क को छोटा कर सकता है। यदि आप इसे छोड़ देते हैं, तो Meshy
3mfको छोड़कर हर फॉर्मेट जनरेट करता है।उपलब्ध मान:
glbobjfbxstlusdz3mf
- Name
- alpha_thumbnail
- Type
- boolean
- डिफ़ॉल्ट false
- Description
क्या पारदर्शी बैकग्राउंड (RGBA) के साथ एक प्रीव्यू भी रेंडर करना है, जो टास्क प्राप्त करने पर
alpha_thumbnail_urlमें लौटाया जाता है।thumbnail_urlनहीं बदलता।
रिटर्न
रिस्पॉन्स का result फ़ील्ड नए Retexture टास्क की ID रखता है।
फेल्योर मोड
- Name
400 - Bad Request- Description
अनुरोध नहीं चल सकता। एरर संदेश बताता है कि कौन सी समस्या मिली। उदाहरण के लिए:
- गुम पैरामीटर: न तो
model_urlऔर न हीinput_task_idभेजा गया। - गुम स्टाइल:
text_style_prompt,image_style_url, औरmultiview_image_urlsमें से कोई भी नहीं भेजा गया। - परस्पर विरोधी स्टाइल इनपुट:
multiview_image_urlsकोtext_style_promptयाimage_style_urlके साथ भेजा गया। - मल्टी-व्यू के लिए असमर्थित मॉडल:
multiview_image_urlsकोmeshy-7याmeshy-n1के स्पष्टai_modelके बिना भेजा गया। - Meshy N1 के लिए असमर्थित विकल्प:
meshy-n1कोenable_pbr: true,remove_lighting,4kया8kकेtexture_resolution,texture_resolutionके बिनाhd_texture: true, याimage_style_urlके बिनाtext_style_promptके साथ भेजा गया। - Meshy N1 के लिए बहुत अधिक त्रिभुज:
meshy-n1के साथ, 3D मॉडल में 7,999,999 से अधिक त्रिभुज हैं। त्रिभुज की संख्या कम करें, या कोई अन्यai_modelउपयोग करें। - Meshy N1 के लिए मॉडल बहुत जटिल है:
meshy-n1के साथ,model_urlफ़ाइल Meshy के लिए इसके त्रिभुज गिनने हेतु बहुत जटिल है। त्रिभुज की संख्या कम करें, फिर फ़ाइल फिर से भेजें। - त्रिभुज गणना का समय समाप्त:
meshy-n1के साथ,model_urlफ़ाइल के त्रिभुज गिनने में बहुत अधिक समय लगा। पुनः प्रयास करें, या मॉडल का आकार कम करें। - अमान्य इनपुट टास्क:
input_task_idकिसी समर्थित प्रकार का सफल टास्क नहीं है। - अमान्य मॉडल फॉर्मेट:
model_urlफ़ाइल में एक असमर्थित एक्सटेंशन है। - अनपहुंच योग्य URL: Meshy
model_urlफ़ाइल,image_style_urlइमेज, या एकmultiview_image_urlsइमेज डाउनलोड नहीं कर सकता। - मॉडल फ़ाइल बहुत बड़ी है:
model_urlफ़ाइलhttpयाhttpsURL से 400 MB से अधिक है, या data URI के रूप में 100 MB से अधिक है। - बहुत अधिक फेस:
model_urlफ़ाइल 100 MB से अधिक है और इसमें 10,000,000 से अधिक फेस हैं। फेस की संख्या कम करें, फिर फ़ाइल फिर से भेजें। - 100 MB से अधिक का ASCII FBX:
model_urlफ़ाइल 100 MB से अधिक का ASCII FBX है। इसे बाइनरी FBX या GLB के रूप में भेजें। - अपठनीय मॉडल फ़ाइल:
model_urlफ़ाइल 100 MB से अधिक है, और Meshy इसका हेडर नहीं पढ़ सकता। उदाहरण के लिए, यह एक Draco-कम्प्रेस्ड GLB या glTF है, या 7.1 से पुराना बाइनरी FBX है। - मॉडल हेडर बहुत जटिल है:
model_urlफ़ाइल 100 MB से अधिक है, और इसके हेडर में जांचने के लिए बहुत अधिक मेश, नोड, या रिकॉर्ड हैं। फ़ाइल में ऑब्जेक्ट की संख्या कम करें, फिर इसे फिर से भेजें। - इमेज बहुत बड़ी है:
image_style_urlइमेज या एकmultiview_image_urlsइमेज 20 MB से अधिक है।
meshy-n1के साथ, एक मॉडल जिसे Meshy टास्क शुरू होने से पहले जांच नहीं सकता, जैसे कि एक STL फ़ाइल, यहां अस्वीकार नहीं किया जाता। यदि इसमें 7,999,999 से अधिक त्रिभुज हैं, तो टास्क विफल हो जाता है, और Meshy इसके क्रेडिट वापस कर देता है।अनुरोध को ठीक करें, फिर इसे फिर से भेजें। Errors देखें।
- गुम पैरामीटर: न तो
- Name
401 - Unauthorized- Description
API की गुम है या अमान्य है।
Authorizationहेडर जांचें।
- Name
402 - Payment Required- Description
उदाहरण के लिए:
- अपर्याप्त क्रेडिट: खाते में इस टास्क के लिए पर्याप्त क्रेडिट नहीं हैं, या खाता एक क्रेडिट सीमा तक पहुंच गया है। अपना क्रेडिट बैलेंस जांचें, फिर पुनः प्रयास करें।
- फ्री प्लान: टास्क बनाने के लिए एक पेड प्लान की आवश्यकता है। अपने सब्सक्रिप्शन सेटिंग्स में अपना प्लान अपग्रेड करें, फिर पुनः प्रयास करें।
- Name
403 - Forbidden- Description
इनमें से एक लागू होता है:
- कंटेंट moderation ने prompt या एक इनपुट इमेज को ब्लॉक कर दिया। इनपुट बदलें, फिर पुनः प्रयास करें।
input_task_idएक बास-रिलीफ मॉडल है, जिसे यह एंडपॉइंट रीटेक्सचर नहीं कर सकता। संदेश हैThis model type does not support this operation। एक अलग मॉडल भेजें।
- Name
404 - Not Found- Description
input_task_idआपके किसी भी टास्क से मेल नहीं खाता। टास्क ID जांचें, फिर अनुरोध फिर से भेजें।
- Name
429 - Too Many Requests- Description
आपने अपनी रेट लिमिट पार कर ली। प्रतीक्षा करें, फिर पुनः प्रयास करें। Rate limits देखें।
Retexture टास्क प्राप्त करें
यह किसी Retexture टास्क को उसकी ID के द्वारा लौटाता है।
Request
curl https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "retexture",
"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=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?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=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
"texture_image_url": "",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"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"
}
],
"task_error": null,
"consumed_credits": 10
}
पैरामीटर
- Name
- id
- Type
- path
- Description
क्रिएट रिस्पॉन्स से प्राप्त टास्क ID।
रिटर्न वैल्यू
एक रीटेक्सचर टास्क को डिलीट करें
किसी रीटेक्सचर टास्क को, उसके मॉडल और डेटा सहित, स्थायी रूप से डिलीट करता है। आप डिलीट को अनडू नहीं कर सकते।
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task 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।
रीटेक्सचर टास्क की सूची
आपके रीटेक्सचर टास्क की एक सूची लौटाता है।
Request
curl https://api.meshy.ai/openapi/v1/retexture?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "retexture",
"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=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"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"
}
],
"task_error": null,
"consumed_credits": 10
}
]
पैरामीटर
- 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: सबसे नया पहले
रिटर्न
रीटेक्सचर टास्क ऑब्जेक्ट्स की एक पेजिनेटेड सूची।
रीटेक्सचर टास्क को स्ट्रीम करें
किसी रीटेक्सचर टास्क के अपडेट्स को Server-Sent Events (SSE) के रूप में स्ट्रीम करता है।
Request
curl -N https://api.meshy.ai/openapi/v1/retexture/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": "retexture",
"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=***",
"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=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?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=***"
},
"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"
}
],
"task_error": null,
"consumed_credits": 10
}
पैरामीटर
- Name
- id
- Type
- path
- Description
क्रिएट रिस्पॉन्स से प्राप्त टास्क ID।
रिटर्न वैल्यू
Retexture task objects की एक स्ट्रीम, Server-Sent Events के रूप में।
प्रत्येक इवेंट में पूरा टास्क ऑब्जेक्ट होता है, उसी फॉर्मेट में जैसा Get एंडपॉइंट रिटर्न करता है। जब तक टास्क PENDING या IN_PROGRESS स्थिति में है, तब तक उसके रिज़ल्ट फ़ील्ड्स में कोई वैल्यू नहीं होती।
रीटेक्सचर टास्क ऑब्जेक्ट
एक रीटेक्सचर टास्क ऑब्जेक्ट किसी 3D मॉडल के एक रीटेक्सचर का वर्णन करता है। इसमें स्टेटस, progress, और टास्क सफल होने पर मॉडल व टेक्सचर फ़ाइलें होती हैं।
Properties
Example Retexture Task Model
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "retexture",
"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=***"
},
"text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
"image_style_url": "https://assets.meshy.ai/***/image/example_image.jpg?Expires=***",
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"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"
}
],
"task_error": null,
"consumed_credits": 10
}
- Name
- id
- Type
- string
- Description
टास्क ID। इसे एक अपारदर्शी (opaque) स्ट्रिंग मानें, और इसके फॉर्मेट पर निर्भर न रहें।
- Name
- type
- Type
- string
- Description
टास्क का प्रकार, हमेशा
retexture।
- Name
- model_urls
- Type
- object
- Description
टेक्सचर युक्त 3D मॉडल के लिए डाउनलोड URL, प्रत्येक फ़ाइल फॉर्मेट के लिए एक।
- Name
glb- Type
- string
- Description
GLB फ़ाइल।
- Name
fbx- Type
- string
- Description
FBX फ़ाइल।
- Name
obj- Type
- string
- Description
OBJ फ़ाइल।
- Name
usdz- Type
- string
- Description
USDZ फ़ाइल।
- Name
mtl- Type
- string
- Description
MTL फ़ाइल। जब मॉडल में टेक्सचर हों, तो Meshy इसे OBJ फ़ाइल के साथ लौटाता है।
- Name
stl- Type
- string
- Description
STL फ़ाइल।
- Name
3mf- Type
- string
- Description
3MF फ़ाइल। यह केवल तभी मौजूद होती है जब
target_formatsमें3mfशामिल हो।
- Name
- text_style_prompt
- Type
- string
- Description
वह टेक्स्ट prompt जिसके साथ आपने टास्क बनाया था।
- Name
- image_style_url
- Type
- string
- Description
वह स्टाइल इमेज जिसके साथ आपने टास्क बनाया था।
- Name
- multiview_image_urls
- Type
- string[]
- Description
उन मल्टी-व्यू रेफरेंस इमेजेज़ के लिए डाउनलोड URL जिनके साथ आपने टास्क बनाया था। यह केवल तभी मौजूद होता है जब आपने टास्क
multiview_image_urlsके साथ बनाया हो।
- Name
- thumbnail_url
- Type
- string
- Description
मॉडल की थंबनेल इमेज के लिए डाउनलोड URL।
- Name
- alpha_thumbnail_url
- Type
- string
- Description
thumbnail_urlके पारदर्शी बैकग्राउंड (RGBA) संस्करण के लिए डाउनलोड URL। यह केवल तभी मौजूद होता है जब आपने टास्कalpha_thumbnail: trueके साथ बनाया हो और Meshy ने पारदर्शी प्रीव्यू रेंडर किया हो।
- Name
- progress
- Type
- integer
- Description
टास्क कितना पूरा हो चुका है, प्रतिशत के रूप में। यह तब तक
0रहता है जब तक टास्क शुरू नहीं होता, और सफल होने पर100हो जाता है।
- Name
- started_at
- Type
- timestamp
- Description
टास्क शुरू होने का समय, यूनिक्स मिलीसेकंड में। यह तब तक
0रहता है जब तक टास्क शुरू नहीं होता।
- Name
- created_at
- Type
- timestamp
- Description
टास्क बनाए जाने का समय, यूनिक्स मिलीसेकंड में।
- Name
- expires_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 के रूप में। आमतौर पर array में एक ही ऑब्जेक्ट होता है। प्रत्येक ऑब्जेक्ट में ये फ़ील्ड होते हैं:
- Name
base_color- Type
- string
- Description
बेस कलर मैप के लिए डाउनलोड URL।
- Name
metallic- Type
- string
- Description
मेटैलिक मैप के लिए डाउनलोड URL। जब आप टास्क
enable_pbr: falseके साथ बनाते हैं, तो Meshy यह फ़ील्ड शामिल नहीं करता।
- Name
normal- Type
- string
- Description
नॉर्मल मैप के लिए डाउनलोड URL। जब आप टास्क
enable_pbr: falseके साथ बनाते हैं, तो Meshy यह फ़ील्ड शामिल नहीं करता।
- Name
roughness- Type
- string
- Description
रफनेस मैप के लिए डाउनलोड URL। जब आप टास्क
enable_pbr: falseके साथ बनाते हैं, तो Meshy यह फ़ील्ड शामिल नहीं करता।
- Name
emission- Type
- string
- Description
एमिशन मैप के लिए डाउनलोड URL। Meshy यह फ़ील्ड तब शामिल नहीं करता जब आप इनमें से कोई भी विकल्प चुनकर टास्क बनाते हैं:
enable_pbr: falsemeshy-6-lite,meshy-7, याlatestकाai_modeltexture_resolution: 8k
- Name
- preceding_tasks
- Type
- integer
- Description
कतार (queue) में इस टास्क से आगे मौजूद टास्कों की संख्या। यह केवल तभी मौजूद होता है जब टास्क
PENDINGहो; मान0होने पर यह फ़ील्ड शामिल नहीं किया जाता।
- Name
- task_error
- Type
- object
- Description
टास्क विफल होने पर एरर का विवरण। देखें एरर।
- Name
- consumed_credits
- Type
- integer
- Description
टास्क द्वारा उपयोग किए गए क्रेडिट की संख्या। यह तब मौजूद होता है जब स्टेटस
PENDING,IN_PROGRESS, याSUCCEEDEDहो।FAILEDटास्क के लिए यह0होता है, क्योंकि टास्क विफल होने पर Meshy क्रेडिट वापस कर देता है।