एक स्रोत फ़ोटो को दो चरणों में चिबी-शैली के संग्रहणीय 3D फिगर में बदलें:
prototype आपकी इनपुट फ़ोटो से एक स्टाइल किया हुआ कॉन्सेप्ट इमेज जनरेट करता है, फिर
build उस कॉन्सेप्ट इमेज को टेक्सचरयुक्त 3D मॉडल में बदलता है। ये दो चरण
input_task_id के ज़रिए लिंक किए जाते हैं।
स्रोत फोटो से एकल चिबी-शैली की कॉन्सेप्ट इमेज जनरेट करें। लौटाई गई
टास्क ID वही है जिसे आप बिल्ड एंडपॉइंट में input_task_id के रूप में
पास करते हैं। प्रतिक्रिया के आकार के लिए
फिगर प्रोटोटाइप टास्क ऑब्जेक्ट
देखें।
पैरामीटर
Name
image_url
Type
string
आवश्यक
Description
Meshy द्वारा चिबी फिगर के रूप में स्टाइलाइज़ करने के लिए स्रोत फोटो। हम वर्तमान में .jpg, .jpeg, .png, और .webp फ़ॉर्मैट का समर्थन करते हैं।
छवि प्रदान करने के दो तरीके हैं:
सार्वजनिक रूप से सुलभ URL: एक URL जो सार्वजनिक इंटरनेट से सुलभ हो।
Data URI: छवि का base64-encoded data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
प्रदर्शन उद्देश्यों के लिए वैकल्पिक टास्क नाम। अधिकतम 100 वर्ण।
रिटर्न
प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए फिगर प्रोटोटाइप टास्क का टास्क id होता है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें जब तक टास्क SUCCEEDED तक नहीं पहुँचता, फिर उस ID को बिल्ड एंडपॉइंट में input_task_id के रूप में पास करें।
विफलता मोड
Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
पैरामीटर अनुपस्थित: image_url आवश्यक है।
अमान्य छवि फ़ॉर्मैट: प्रदान किया गया image_url समर्थित फ़ॉर्मैट (.jpg, .jpeg, .png, .webp) नहीं है।
छवि आयाम सीमा से बाहर: छवि बहुत छोटी है, अधिकतम फ़ाइल आकार से अधिक है, या अधिकतम पिक्सेल संख्या से अधिक है।
अप्राप्य URL: image_url डाउनलोड नहीं किया जा सका (404 या timeout)।
अमान्य Data URI: base64 स्ट्रिंग गलत रूप में है।
कंटेंट फ़्लैग किया गया: इनपुट छवि को NSFW या बौद्धिक संपदा moderation द्वारा फ़्लैग किया गया था।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
सफल प्रोटोटाइप टास्क से अंतिम टेक्सचरयुक्त 3D फिगर जनरेट करें।
बिल्ड वही इमेज-से-3D पाइपलाइन चलाता है जो
इमेज से 3D में है, इसलिए response ऑब्जेक्ट का फ़ॉर्मैट और
आउटपुट URLs की सूची बिल्कुल मेल खाती है। response के आकार के लिए
फिगर बिल्ड टास्क ऑब्जेक्ट देखें।
पैरामीटर
Name
input_task_id
Type
string
आवश्यक
Description
इसी OpenAPI एंडपॉइंट के माध्यम से बनाए गए प्रोटोटाइप टास्क की task ID। प्रोटोटाइप को उसी API की से बनाया गया होना चाहिए, उसे SUCCEEDED तक पहुँचना चाहिए, और उसने ठीक एक candidate image बनाई होनी चाहिए।
webapp के माध्यम से बनाए गए प्रोटोटाइप टास्क स्वीकार नहीं किए जाते — बिल्ड एंडपॉइंट केवल POST /openapi/creative-lab/figure/v1/prototype द्वारा बनाए गए प्रोटोटाइप टास्क स्वीकार करता है और किसी भी अन्य स्रोत को 404 के साथ अस्वीकार करता है।
Name
name
Type
string
Description
प्रदर्शन के उद्देश्य से वैकल्पिक टास्क नाम। अधिकतम 100 अक्षर।
रिटर्न
response की result property में नए बनाए गए फिगर बिल्ड टास्क का task id होता है। Get a Task एंडपॉइंट को poll करें या stream की सदस्यता लें जब तक टास्क SUCCEEDED तक न पहुँच जाए, फिर model_urls.glb से टेक्सचरयुक्त GLB डाउनलोड करें (या यदि आपकी downstream pipeline OBJ को प्राथमिकता देती है, तो model_urls.obj और model_urls.mtl से OBJ + MTL pair डाउनलोड करें)।
विफलता मोड
Name
400 - Bad Request
Description
request स्वीकार्य नहीं था। सामान्य कारण:
अनुपस्थित पैरामीटर: input_task_id आवश्यक है।
अमान्य UUID: input_task_id मान्य UUID नहीं है।
Parent सफल नहीं हुआ: संदर्भित प्रोटोटाइप टास्क अभी SUCCEEDED तक नहीं पहुँचा है।
कोई candidate नहीं: प्रोटोटाइप टास्क सफल हुआ, लेकिन उसने कोई candidate image नहीं बनाई।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
404 - Not Found
Description
संदर्भित प्रोटोटाइप टास्क मौजूद नहीं है, किसी अलग उपयोगकर्ता का है, या webapp के माध्यम से बनाया गया था (केवल API-mode प्रोटोटाइप टास्क बिल्ड में chain होते हैं)।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build example
The build task turns the selected prototype image into a downloadable textured 3D model.
मान्य टास्क id दिए जाने पर प्रोटोटाइप या बिल्ड टास्क पुनः प्राप्त करें। URL पाथ
टास्क के चरण से मेल खाना चाहिए — बिल्ड टास्क को
/prototype/:id के माध्यम से फ़ेच करने पर 404 लौटता है, और इसके विपरीत भी।
किसी फिगर टास्क को रद्द करें। यदि टास्क अभी भी PENDING है, तो create-time पर
उपभोग किए गए क्रेडिट वापस कर दिए जाते हैं। जो टास्क पहले से
IN_PROGRESS हैं, उन्हें बिना रिफंड के रद्द किया जाता है (worker पहले से
रिसोर्सेज़ खर्च कर रहा हो सकता है)। जो टास्क पहले ही किसी अंतिम अवस्था तक पहुँच चुके हैं
(SUCCEEDED, FAILED, CANCELED), उन्हें रद्द नहीं किया जा सकता।
URL पाथ को टास्क के stage से मेल खाना चाहिए — DELETE को
/prototype/:buildId पर करने से 404 लौटता है।
पाथ पैरामीटर्स
Name
id
Type
path
Description
रद्द किए जाने वाले फिगर टास्क के लिए विशिष्ट पहचानकर्ता।
रिटर्न्स
सफलता पर खाली body के साथ 204 No Content लौटाता है।
विफलता मोड्स
Name
400 - Bad Request
Description
टास्क पहले से किसी अंतिम अवस्था में है और उसे रद्द नहीं किया जा सकता।
Name
404 - Not Found
Description
टास्क मौजूद नहीं है, किसी अलग यूज़र से संबंधित है, या उसका stage URL पाथ से मेल नहीं खाता।
Server-Sent Events (SSE) के माध्यम से फिगर टास्क के लिए रीयल-टाइम अपडेट स्ट्रीम करें।
URL पाथ टास्क के चरण से मेल खाना चाहिए —
/prototype/:buildId/stream पर स्ट्रीम खोलने से एकल event: error पेलोड
status_code: 404 के साथ भेजा जाता है और स्ट्रीम बंद हो जाती है।
पैरामीटर
Name
id
Type
path
Description
स्ट्रीम करने के लिए फिगर टास्क का अद्वितीय आइडेंटिफायर।
रिटर्न
फिगर प्रोटोटाइप
या फिगर बिल्ड टास्क ऑब्जेक्ट्स की स्ट्रीम
Server-Sent Events के रूप में लौटाता है। PENDING या IN_PROGRESS टास्क के लिए, रिस्पॉन्स
स्ट्रीम में केवल आवश्यक progress और status फ़ील्ड शामिल होंगे।
किसी एक चरण के लिए अपने फिगर टास्क की पेजिनेशन वाली सूची प्राप्त करें। URL
पाथ चरण चुनता है — /prototype प्रोटोटाइप टास्क लौटाता है; /build
बिल्ड टास्क लौटाता है। दूसरे चरण के टास्क किसी भी
रिस्पॉन्स में शामिल नहीं होते हैं।
पाथ पैरामीटर
Name
stage
Type
path
आवश्यक
Description
या तो prototype या build। कलेक्शन केवल वे टास्क लौटाता है
जिनका चरण URL से मेल खाता है — /prototype फ़ेच करने पर कभी भी
बिल्ड टास्क नहीं मिलते और इसके विपरीत भी।
क्वेरी पैरामीटर
Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
पेजिनेशन के लिए पेज संख्या।
Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
पेज आकार सीमा। अधिकतम अनुमत 50 आइटम हैं।
Name
sort_by
Type
string
डिफ़ॉल्ट -created_at
Description
जिस फ़ील्ड के आधार पर सॉर्ट करना है। उपलब्ध मान:
+created_at: निर्माण समय के आधार पर आरोही क्रम में सॉर्ट करें।
-created_at: निर्माण समय के आधार पर अवरोही क्रम में सॉर्ट करें।
फिगर प्रोटोटाइप टास्क ऑब्जेक्ट एक कार्य इकाई है जिसका Meshy एक स्रोत फोटो से
चिबी-शैली की कॉन्सेप्ट इमेज जनरेट करने के लिए ट्रैक रखता है। इस चरण का आउटपुट
input_task_id के माध्यम से बिल्ड चरण
में चेन किया जाता है।
प्रॉपर्टीज
Name
id
Type
string
Description
टास्क के लिए अद्वितीय पहचानकर्ता। हालांकि हम इम्प्लीमेंटेशन विवरण के रूप में टास्क ids के लिए k-sortable UUID का उपयोग करते हैं, आपको id के फ़ॉर्मेट के बारे में कोई भी अनुमान नहीं लगाना चाहिए।
Name
type
Type
string
Description
टास्क का प्रकार। मान creative-lab-figure-prototype है।
Name
name
Type
string
Description
टास्क बनाते समय दिया गया टास्क नाम। यदि कोई नाम नहीं दिया गया था तो खाली स्ट्रिंग।
Name
status
Type
string
Description
टास्क की स्थिति। संभावित मान PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक हैं।
Name
progress
Type
integer
Description
टास्क का progress। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी। एक बार टास्क सफल हो जाने पर, यह 100 हो जाएगी।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।
टाइमस्टैंप 1 जनवरी, 1970 UTC से बीते मिलीसेकंड की संख्या को दर्शाता है, जो
RFC 3339 मानक का पालन करता है।
उदाहरण के लिए, शुक्रवार, 1 सितंबर, 2023 12:00:00 PM GMT को 1693569600000 के रूप में दर्शाया जाता है। यह Meshy API में
सभी टाइमस्टैंप पर लागू होता है।
Name
started_at
Type
timestamp
Description
टास्क शुरू होने का टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
Name
finished_at
Type
timestamp
Description
टास्क समाप्त होने का टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी समाप्त नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
Name
expires_at
Type
timestamp
Description
टास्क परिणाम की समाप्ति का टाइमस्टैंप, मिलीसेकंड में।
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 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।
Name
image_urls
Type
array of strings
Description
इस प्रोटोटाइप टास्क द्वारा जनरेट किए गए कॉन्सेप्ट इमेज उम्मीदवारों के डाउनलोड योग्य URLs। वर्तमान में API हमेशा ठीक एक उम्मीदवार लौटाता है; फ़ील्ड एक ऐरे है ताकि भविष्य के संशोधन बिना breaking change के कई उम्मीदवार दिखा सकें।
फिगर बिल्ड कार्य ऑब्जेक्ट एक वर्क यूनिट है जिसे Meshy एक सफल प्रोटोटाइप कार्य से
textured 3D फिगर जनरेट करने के लिए ट्रैक करता है। यह
इमेज से 3D द्वारा उपयोग की जाने वाली वही इमेज-से-3D पाइपलाइन चलाता है,
इसलिए आउटपुट फ़ील्ड उस एंडपॉइंट के कार्य ऑब्जेक्ट को प्रतिबिंबित करते हैं।
प्रॉपर्टीज
Name
id
Type
string
Description
टास्क के लिए यूनिक आइडेंटिफ़ायर।
Name
type
Type
string
Description
टास्क का प्रकार। वैल्यू creative-lab-figure-build है।
Name
name
Type
string
Description
टास्क बनाए जाने पर दिया गया टास्क नाम। यदि कोई नाम नहीं दिया गया था, तो खाली स्ट्रिंग।
Name
status
Type
string
Description
टास्क का स्टेटस। संभावित वैल्यूज़ PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक हैं।
Name
progress
Type
integer
Description
टास्क का progress। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी। टास्क के सफल हो जाने के बाद, यह 100 हो जाएगी।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।
Name
started_at
Type
timestamp
Description
टास्क शुरू किए जाने का टाइमस्टैंप, मिलीसेकंड में।
Name
finished_at
Type
timestamp
Description
टास्क समाप्त होने का टाइमस्टैंप, मिलीसेकंड में।
Name
expires_at
Type
timestamp
Description
टास्क परिणाम की समाप्ति का टाइमस्टैंप, मिलीसेकंड में।
Name
preceding_tasks
Type
integer
Description
पूर्ववर्ती टास्क की संख्या। केवल तब अर्थपूर्ण जब स्टेटस PENDING हो।
Name
task_error
Type
object
Description
विफल टास्क के लिए एरर विवरण। पूरे task_error ऑब्जेक्ट रेफ़रेंस के लिए एरर देखें।
Name
consumed_credits
Type
integer
Description
इस टास्क द्वारा उपयोग किए गए क्रेडिट की संख्या। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।
Name
prompt
Type
string
Description
फिगर बिल्ड के लिए हमेशा खाली। इमेज से 3D द्वारा उपयोग किए जाने वाले साझा V2ImageTo3DTaskResponse शेप के साथ क्रॉस-एंडपॉइंट संगतता के लिए मौजूद।
Name
negative_prompt
Type
string
Description
फिगर बिल्ड के लिए हमेशा खाली। क्रॉस-एंडपॉइंट संगतता के लिए मौजूद।
Name
texture_prompt
Type
string
Description
फिगर बिल्ड के लिए हमेशा खाली। क्रॉस-एंडपॉइंट संगतता के लिए मौजूद।
Name
texture_image_url
Type
string
Description
फिगर बिल्ड के लिए हमेशा खाली। क्रॉस-एंडपॉइंट संगतता के लिए मौजूद।
Name
model_urls
Type
object
Description
जनरेट किए गए 3D मॉडल के लिए डाउनलोड करने योग्य URLs। फिगर बिल्ड एक टेक्सचर वाला GLB और उन पाइपलाइनों के लिए OBJ + MTL जोड़ी उत्सर्जित करता है जो Wavefront OBJ को प्राथमिकता देती हैं। फ़ील्ड शेप इमेज से 3D model_urls ऑब्जेक्ट से मेल खाता है ताकि भविष्य के फ़ॉर्मैट जोड़ बिना ब्रेकिंग चेंज के फिट हो सकें।
Name
glb
Type
string
Description
टेक्सचर वाली GLB फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
obj
Type
string
Description
Wavefront OBJ फ़ाइल (ज्यामिति + UV) के लिए डाउनलोड करने योग्य URL।
Name
mtl
Type
string
Description
OBJ companion MTL मटेरियल फ़ाइल के लिए डाउनलोड करने योग्य URL। obj और texture_urls[0].base_color से एंट्री के साथ पेयर करें।
Name
thumbnail_url
Type
string
Description
मॉडल फ़ाइल की थंबनेल इमेज के लिए डाउनलोड करने योग्य URL।
Name
texture_urls
Type
array
Description
इस टास्क द्वारा जनरेट किए गए टेक्सचर URL ऑब्जेक्ट्स की एक ऐरे। वर्तमान में बेस कलर मैप वाला एक ही ऑब्जेक्ट शामिल है।