रीटेक्सचर API एक ऐसी सुविधा है जो आपको Meshy की AI रीटेक्सचर क्षमताओं को अपने स्वयं के एप्लिकेशन में एकीकृत करने देती है। इस सेक्शन में, आपको इस API के साथ शुरुआत करने के लिए आवश्यक सभी जानकारी
मिलेगी।
POST/openapi/v1/retexture
रीटेक्सचर टास्क बनाएँ
यह एंडपॉइंट आपको एक नया रीटेक्सचर टास्क बनाने देता है। रीटेक्सचर टास्क ऑब्जेक्ट में कौन-सी
प्रॉपर्टी शामिल हैं, यह देखने के लिए
रीटेक्सचर टास्क ऑब्जेक्ट देखें।
पैरामीटर
input_task_id या model_url में से केवल एक आवश्यक है। यदि दोनों दिए गए हैं, तो input_task_id को प्राथमिकता मिलती है।
Name
input_task_id
Type
string
आवश्यक
Description
उस पूर्ण हुए इमेज से 3D या टेक्स्ट से 3D टास्क की ID जिसे आप रीटेक्सचर करना चाहते हैं।
यह टास्क निम्नलिखित टास्क में से एक होना चाहिए: टेक्स्ट से 3D Preview, टेक्स्ट से 3D Refine, इमेज से 3D या रीमेश। इसके अलावा, इसका स्टेटस SUCCEEDED होना चाहिए।
Name
model_url
Type
string
आवश्यक
Description
Meshy को टेक्सचर करने के लिए एक 3D मॉडल दें। समर्थित फ़ॉर्मैट: .glb, .gltf, .obj, .fbx, .stl.
मॉडल देने के दो तरीके हैं:
सार्वजनिक रूप से पहुँच योग्य URL: एक URL जो सार्वजनिक इंटरनेट से पहुँच योग्य हो।
Data URI: मॉडल का base64-encoded data URI। MIME type application/octet-stream का उपयोग करें। उदाहरण: data:application/octet-stream;base64,<your base64-encoded model data>.
text_style_prompt या image_style_url में से केवल एक आवश्यक है। यदि दोनों दिए गए हैं, तो image_style_url को प्राथमिकता मिलती है।
Name
text_style_prompt
Type
string
आवश्यक
Description
टेक्स्ट का उपयोग करके ऑब्जेक्ट की अपनी इच्छित टेक्सचर शैली का वर्णन करें। अधिकतम 600 अक्षर।
Name
image_style_url
Type
string
आवश्यक
Description
टेक्सचरिंग प्रक्रिया का मार्गदर्शन करने के लिए एक 2d इमेज दें। हम वर्तमान में .jpg, .jpeg, और .png फ़ॉर्मैट का समर्थन करते हैं।
इमेज देने के दो तरीके हैं:
सार्वजनिक रूप से पहुँच योग्य URL: एक URL जो सार्वजनिक इंटरनेट से पहुँच योग्य हो
Data URI: इमेज का base64-encoded data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>
यदि मूल एसेट और अपलोड की गई इमेज के बीच ज्यामिति में पर्याप्त अंतर हैं, तो इमेज टेक्सचरिंग इष्टतम रूप से काम नहीं कर सकती।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
रीटेक्सचरिंग के लिए उपयोग किए जाने वाले AI मॉडल की ID। उपलब्ध मान: meshy-5, meshy-6, latest (Meshy 6)।
Name
enable_original_uv
Type
boolean
डिफ़ॉल्ट false
Description
नया UV लेआउट जनरेट करने के बजाय मॉडल का मौजूदा UV लेआउट रखें।
यदि आप Meshy द्वारा जनरेट किए गए मॉडल को रीटेक्सचर कर रहे हैं (input_task_id के माध्यम से, या ऐसा model_url जो Meshy आउटपुट की ओर इशारा करता है), तो इसके अनुकूलित UV लेआउट का पुनः उपयोग करने के लिए इसे true पर सेट करें।
यदि आप अपने द्वारा अपलोड किए गए किसी तृतीय-पक्ष मॉडल को रीटेक्सचर कर रहे हैं, तो जब उसमें पहले से अच्छे UV हों जिन्हें आप रखना चाहते हैं, तब true सेट करें, या Meshy को नए UV अनरैप करने देने के लिए इसे false रहने दें (उन मॉडलों के लिए सबसे अच्छा जिनमें उचित UV मैपिंग नहीं है)।
Name
enable_pbr
Type
boolean
डिफ़ॉल्ट false
Description
बेस कलर के अतिरिक्त PBR मैप (metallic, roughness, normal) जनरेट करें। जब ai_modelmeshy-6 या latest हो, तब एक emission map भी शामिल होता है।
Name
hd_texture
Type
boolean
डिफ़ॉल्ट false
Description
अधिक विवरण के लिए बेस कलर टेक्सचर को 4K (4096×4096) रिज़ॉल्यूशन पर जनरेट करें।
केवल तब समर्थित है जब ai_modelmeshy-6 या latest हो। PBR मैप हमेशा 2K पर जनरेट होते हैं।
Name
remove_lighting
Type
boolean
डिफ़ॉल्ट true
Description
बेस कलर टेक्सचर से हाइलाइट और छायाएँ हटाता है, जिससे एक साफ़ परिणाम मिलता है जो कस्टम लाइटिंग सेटअप के तहत बेहतर काम करता है।
केवल तब समर्थित है जब ai_modelmeshy-6 या latest हो।
Name
target_formats
Type
string[]
Description
निर्दिष्ट करता है कि आउटपुट में कौन-से 3D फ़ाइल फ़ॉर्मैट शामिल करने हैं। केवल अनुरोधित फ़ॉर्मैट जनरेट और लौटाए जाएँगे, जिससे टास्क पूरा होने का समय कम हो सकता है। छोड़े जाने पर, सभी समर्थित फ़ॉर्मैट शामिल होते हैं।
उपलब्ध मान: glb, obj, fbx, stl, usdz, 3mf
छोड़े जाने पर, 3mf को छोड़कर सभी फ़ॉर्मैट जनरेट होते हैं। 3mf केवल तब शामिल होता है जब स्पष्ट रूप से निर्दिष्ट किया गया हो।
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
true पर सेट होने पर, टास्क अतिरिक्त रूप से preview का एक transparent-background (RGBA) संस्करण रेंडर करता है और GET response पर इसे alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहता है।
रिटर्न
response की result प्रॉपर्टी में नए बनाए गए रीटेक्सचर टास्क की टास्क id होती है।
विफलता मोड
Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
गुम पैरामीटर: या तो model_url या input_task_id दिया जाना चाहिए।
गुम शैली: या तो text_style_prompt या image_style_url दिया जाना चाहिए।
अमान्य इनपुट टास्क: input_task_id को किसी समर्थित मॉडल से सफल टास्क को संदर्भित करना चाहिए।
अमान्य मॉडल फ़ॉर्मैट: model_url एक असमर्थित extension वाली फ़ाइल की ओर इशारा करता है।
पहुँच से बाहर URL: model_url या image_style_url डाउनलोड नहीं किया जा सका।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/v1/retexture
# Retexture with text promptcurl 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 PBRcurl 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": "https://cdn.meshy.ai/image/example_image.jpg", "ai_model": "latest", "enable_pbr": true, "enable_original_uv": true }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
GET/openapi/v1/retexture/:id
रीटेक्सचर टास्क प्राप्त करें
यह एंडपॉइंट आपको वैध task id दिए जाने पर रीटेक्सचर टास्क प्राप्त करने की अनुमति देता है।
रीटेक्सचर टास्क ऑब्जेक्ट में कौन-सी properties शामिल हैं, यह देखने के लिए
रीटेक्सचर टास्क ऑब्जेक्ट देखें।
पैरामीटर
Name
id
Type
path
Description
प्राप्त किए जाने वाले रीटेक्सचर टास्क के लिए विशिष्ट पहचानकर्ता।
रिटर्न
प्रतिक्रिया में रीटेक्सचर टास्क ऑब्जेक्ट शामिल होता है। विवरण के लिए
रीटेक्सचर टास्क ऑब्जेक्ट अनुभाग देखें।
{"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","emission":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX" } ],"task_error": {"message":"" },"consumed_credits":10}
[ {"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","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":10 }]
रीटेक्सचर टास्क ऑब्जेक्ट एक कार्य इकाई है जिसका उपयोग Meshy टेक्स्ट या इमेज इनपुट से 3D टेक्सचर जनरेट करने के लिए करता है।
मॉडल में निम्नलिखित गुण हैं:
प्रॉपर्टीज
Name
id
Type
string
Description
टास्क के लिए विशिष्ट पहचानकर्ता। हालांकि हम कार्यान्वयन विवरण के रूप में टास्क ids के लिए
k-sortable UUID का उपयोग करते हैं, आपको id के फ़ॉर्मेट के बारे में कोई भी अनुमान नहीं लगाना चाहिए।
Name
type
Type
string
Description
रीटेक्सचर टास्क का प्रकार। मान retexture है।
Name
model_urls
Type
object
Description
Meshy द्वारा जनरेट की गई टेक्सचरयुक्त 3D मॉडल फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
glb
Type
string
Description
GLB फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
fbx
Type
string
Description
FBX फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
obj
Type
string
Description
OBJ फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
usdz
Type
string
Description
USDZ फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
mtl
Type
string
Description
MTL फ़ाइल के लिए डाउनलोड करने योग्य URL, जब टेक्सचर मौजूद हों तो OBJ एक्सपोर्ट के साथ लौटाया जाता है।
Name
stl
Type
string
Description
STL फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
3mf
Type
string
Description
3MF फ़ाइल के लिए डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब target_formats के माध्यम से 3mf अनुरोध किया गया हो।
Name
text_style_prompt
Type
string
Description
यह वह टेक्स्ट prompt है जिसका उपयोग टेक्सचरिंग टास्क बनाने के लिए किया गया था।
Name
image_style_url
Type
string
Description
यह वह इमेज इनपुट है जिसका उपयोग टेक्सचरिंग टास्क बनाने के लिए किया गया था।
Name
thumbnail_url
Type
string
Description
मॉडल फ़ाइल की थंबनेल इमेज के लिए डाउनलोड करने योग्य URL।
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url के पारदर्शी-बैकग्राउंड (RGBA) संस्करण के लिए डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब टास्क alpha_thumbnail: true के साथ बनाया गया हो और पारदर्शी प्रीव्यू सफलतापूर्वक रेंडर किया गया हो; अन्यथा यह फ़ील्ड छोड़ दी जाती है।
Name
progress
Type
integer
Description
टास्क का progress। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी। टास्क के सफल हो जाने के बाद, यह 100 हो जाएगा।
Name
started_at
Type
timestamp
Description
टास्क शुरू होने का टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
टाइमस्टैंप, 1 जनवरी 1970 UTC से बीते मिलीसेकंड की संख्या को दर्शाता है, जो
RFC 3339 मानक का पालन करता है।
उदाहरण के लिए, शुक्रवार, 1 सितंबर 2023 12:00:00 PM GMT को 1693569600000 के रूप में दर्शाया जाता है। यह Meshy API में
सभी टाइमस्टैंप पर लागू होता है।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।
Name
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 ऑब्जेक्ट्स की एक ऐरे। सामान्यतः इसमें केवल एक टेक्सचर 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_modelmeshy-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 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","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":10}