एक स्रोत फोटो को ईंट-शैली के संग्रहणीय 3D मिनीफिगर में बदलें दो चरणों में:
प्रोटोटाइप आपके इनपुट फोटो से एक स्टाइल वाली अवधारणा छवि उत्पन्न करता है, उसके बाद
बिल्ड उस अवधारणा छवि को एक textured 3D मॉडल में बदलता है। दोनों चरण
input_task_id के माध्यम से जुड़े होते हैं।
POST /openapi/creative-lab/brick-figure/v1/prototype
स्रोत फोटो से एकल ईंट-शैली की अवधारणा छवि उत्पन्न करें। लौटाया गया कार्य आईडी वही है जिसे आप input_task_id के रूप में बिल्ड एंडपॉइंट में पास करते हैं। प्रतिक्रिया आकार के लिए ईंट के फिगर प्रोटोटाइप कार्य वस्तु देखें।
पैरामीटर
Name
image_url
Type
string
आवश्यक
Description
Meshy को स्रोत फोटो को ईंट मिनीफिगर के रूप में स्टाइल करने के लिए। हम वर्तमान में .jpg, .jpeg, .png, और .webp प्रारूपों का समर्थन करते हैं।
छवि प्रदान करने के दो तरीके हैं:
सार्वजनिक रूप से सुलभ URL: एक URL जो सार्वजनिक इंटरनेट से सुलभ है।
Data URI: छवि का base64-कूटित डेटा URI। Data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
प्रदर्शन के लिए वैकल्पिक कार्य नाम। अधिकतम 100 अक्षर।
रिटर्न
प्रतिक्रिया की result प्रॉपर्टी में नवनिर्मित ईंट के फिगर प्रोटोटाइप कार्य की id होती है। तब तक एक कार्य प्राप्त करें एंडपॉइंट को जाँचें या स्ट्रीम की सदस्यता लें जब तक कार्य SUCCEEDED नहीं हो जाता है, फिर उस आईडी को बिल्ड एंडपॉइंट में 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
403 - Forbidden
Description
इनपुट छवि को बौद्धिक संपदा उल्लंघन के लिए चिह्नित किया गया।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# चरण 1: ईंट-शैली की अवधारणा छवि उत्पन्न करेंcurl https://api.meshy.ai/openapi/creative-lab/brick-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>" }'
एक सफल प्रोटोटाइप कार्य से अंतिम बनावटयुक्त 3D ईंट आकृति उत्पन्न करें। निर्माण प्रक्रिया उसी इमेज-से-3D पाइपलाइन को चलाता है जैसे इमेज से 3D, इसलिए प्रतिक्रिया ऑब्जेक्ट प्रारूप और आउटपुट URL की सूची बिल्कुल मेल खाती है। प्रतिक्रिया संरचना के लिए ईंट आकृति निर्माण कार्य ऑब्जेक्ट देखें।
पैरामीटर
Name
input_task_id
Type
string
आवश्यक
Description
इस ही OpenAPI एंडपॉइंट के माध्यम से बनाए गए प्रोटोटाइप कार्य का कार्य ID। प्रोटोटाइप को उसी API की के साथ बनाया गया होगा, SUCCEEDED तक पहुँचना होगा, और बिल्कुल एक ही उम्मीदवार इमेज का उत्पादन करना होगा।
वेबऐप के माध्यम से बनाए गए प्रोटोटाइप कार्य स्वीकार नहीं किए जाते हैं — निर्माण एंडपॉइंट केवल POST /openapi/creative-lab/brick-figure/v1/prototype द्वारा उत्पन्न प्रोटोटाइप कार्य स्वीकार करता है और किसी अन्य स्रोत को 404 के साथ अस्वीकार करता है।
Name
name
Type
string
Description
प्रदर्शन हेतु वैकल्पिक कार्य नाम। अधिकतम 100 अक्षर।
रिटर्न्स
प्रतिक्रिया की result प्रॉपर्टी में नव निर्मित ईंट आकृति निर्माण कार्य का कार्य id होता है। एक कार्य प्राप्त करें एंडपॉइंट को पोल करें या स्ट्रीम को सब्सक्राइब करें जब तक कि कार्य SUCCEEDED तक न पहुँच जाए, फिर बनावटयुक्त GLB को model_urls.glb से डाउनलोड करें (या यदि आपका डाउनस्ट्रीम पाइपलाइन OBJ को प्राथमिकता देता है तो model_urls.obj और model_urls.mtl से OBJ + MTL जोड़ी)।
विफल मोड्स
Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
पैरामीटर की कमी: input_task_id आवश्यक है।
अवैध UUID: input_task_id एक मान्य UUID नहीं है।
मूलक सफल नहीं हुआ: संदर्भित प्रोटोटाइप कार्य अभी तक SUCCEEDED नहीं हुआ।
कोई उम्मीदवार नहीं: प्रोटोटाइप कार्य सफल हो गया लेकिन कोई उम्मीदवार इमेज उत्पन्न नहीं की।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल। कृपया अपनी API की जांचें।
Name
402 - Payment Required
Description
इस कार्य को करने के लिए अपर्याप्त क्रेडिट।
Name
404 - Not Found
Description
संदर्भित प्रोटोटाइप कार्य मौजूद नहीं है, एक अलग उपयोगकर्ता का है, या वेबऐप के माध्यम से बनाया गया था (केवल API-मोड प्रोटोटाइप कार्य निर्माण में जोड़ते हैं)।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट को पार कर लिया है।
अनुरोध
POST
/openapi/creative-lab/brick-figure/v1/build
# चरण 2: सफल प्रोटोटाइप कार्य से श्रृंखला निर्माणcurl https://api.meshy.ai/openapi/creative-lab/brick-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" }'
एक वैध कार्य id के लिए एक प्रोटोटाइप या निर्माण कार्य प्राप्त करें। URL पथ
कार्य के चरण से मेल खाना चाहिए — /prototype/:id के माध्यम से प्राप्त किया गया निर्माण कार्य
404 वापस करता है, और इसके विपरीत।
एक ब्रिक फिगर टास्क रद्द करें। यदि टास्क अभी भी PENDING है, तो बनाए जाने के समय उपयोग किए गए क्रेडिट वापस किए जाते हैं। टास्क जो पहले से IN_PROGRESS हैं, उन्हें बिना रिफंड के रद्द कर दिया जाता है (संभव है कि कार्यकर्ता रिसोर्सेज़ पर कष्ट कर रहा हो)। टास्क जो पहले ही टर्मिनल स्टेट में पहुँच चुके हैं (SUCCEEDED, FAILED, CANCELED) उन्हें रद्द नहीं किया जा सकता।
URL पथ को टास्क के स्टेज के साथ मेल खाना चाहिए — /prototype/:buildId पर DELETE404 लौटाता है।
पाथ पैरामीटर्स
Name
id
Type
path
Description
रद्द करने के लिए ब्रिक फिगर टास्क का अद्वितीय पहचानकर्ता।
रिटर्न्स
सफल होने पर 204 No Content खाली बॉडी के साथ लौटाता है।
विफलता के रूप
Name
400 - Bad Request
Description
टास्क पहले से ही एक टर्मिनल स्टेट में है और रद्द नहीं की जा सकती।
Name
404 - Not Found
Description
टास्क अस्तित्व में नहीं है, एक अलग उपयोगकर्ता की है, या उसका स्टेज URL पथ से मेल नहीं खाता।
एसएसई (Server-Sent Events) के माध्यम से एक ब्रिक फिगर कार्य के लिए वास्तविक समय अपडेट स्ट्रीम करें।
URL पथ को कार्य के चरण से मेल खाना चाहिए — /prototype/:buildId/stream पर एक स्ट्रीम खोलने से एकल event: error पेलोड के साथ
status_code: 404 उत्पन्न होता है और स्ट्रीम बंद हो जाती है।
पैरामीटर्स
Name
id
Type
path
Description
स्ट्रीम करने के लिए ब्रिक फिगर कार्य के लिए अद्वितीय पहचानकर्ता।
रिटर्न्स
Brick Figure Prototype या Brick Figure Build कार्य वस्तुओं की स्ट्रीम को
Server-Sent Events के रूप में लौटाता है। PENDING या IN_PROGRESS कार्यों के लिए प्रतिक्रिया
स्ट्रीम केवल आवश्यक progress और status फ़ील्ड्स को शामिल करेगा।
// त्रुटि घटना उदाहरण (गलत चरण या कार्य नहीं मिला)event: errordata: {"status_code": 404,"message": "Task not found"}// संदेश घटना उदाहरण कार्य प्रगति को दर्शाते हैं।// PENDING या IN_PROGRESS कार्यों के लिए, प्रतिक्रिया स्ट्रीम में सभी फ़ील्ड्स शामिल नहीं होंगे।event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-brick-figure-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 30,"prompt": "","negative_prompt": "","texture_prompt": "","texture_image_url": "","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***","obj":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***" },"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***" } ]}
एकल चरण के लिए अपने ब्रिक फिगर टास्क्स की पेजिनेटेड सूची प्राप्त करें। 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
पेज आकार सीमा। अधिकतम अनुमत 100 आइटम हैं।
Name
sort_by
Type
string
डिफ़ॉल्ट -created_at
Description
क्रमबद्ध करने के लिए फ़ील्ड। उपलब्ध मान:
+created_at: निर्माण समय के अनुसार आरोही क्रम में क्रमबद्ध करें।
-created_at: निर्माण समय के अनुसार अवरोही क्रम में क्रमबद्ध करें।
ब्रिक फ़िगर प्रोटोटाइप टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे Meshy स्रोत फोटो से एक ब्रिक-शैली की कॉन्सेप्ट इमेज उत्पन्न करने के लिए ट्रैक करता है। इस चरण का आउटपुट input_task_id के माध्यम से निर्माण चरण में जोड़ा जाता है।
प्रॉपर्टी
Name
id
Type
string
Description
कार्य के लिए अद्वितीय पहचानकर्ता। हम कार्य आईडी के लिए कार्यान्वयन विवरण के रूप में k-sortable UUID का उपयोग करते हैं, लेकिन आपको पहचानकर्ता के प्रारूप के बारे में कोई अनुमान नहीं लगाना चाहिए।
Name
type
Type
string
Description
कार्य का प्रकार। मान creative-lab-brick-figure-prototype है।
Name
name
Type
string
Description
कार्य का नाम जब कार्य बनाया गया था तब आपूर्ति किया गया था। यदि कोई नाम प्रदान नहीं किया गया हो तो खाली स्ट्रिंग।
Name
status
Type
string
Description
कार्य की स्थिति। संभावित मान PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक होते हैं।
Name
progress
Type
integer
Description
कार्य की प्रगति। यदि कार्य अभी तक शुरू नहीं हुआ है, तो यह प्रॉपर्टी 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
कार्य के शुरू होने का समयांक, मिलिसेकंड में। यदि कार्य अभी तक शुरू नहीं हुआ है, तो यह प्रॉपर्टी null होगी।
Name
finished_at
Type
timestamp
Description
कार्य के समाप्त होने का समयांक, मिलिसेकंड में। यदि कार्य अभी तक समाप्त नहीं हुआ है, तो यह प्रॉपर्टी null होगी।
Name
expires_at
Type
timestamp
Description
कार्य परिणाम के समाप्त होने का समयांक, मिलिसेकंड में।
Name
preceding_tasks
Type
integer
Description
पूर्ववर्ती कार्यों की संख्या।
इस फ़ील्ड का मान केवल तभी सार्थक होता है जब कार्य का स्टेटस PENDING होता है।
Name
task_error
Type
object
Description
असफल कार्यों के लिए त्रुटि विवरण। task_error ऑब्जेक्ट संदर्भ के लिए Errors देखें।
Name
consumed_credits
Type
integer
Description
इस कार्य द्वारा उपभोग किए गए क्रेडिट की संख्या। तब उपस्थित जब कार्य का स्टेटस PENDING, IN_PROGRESS, या SUCCEEDED होता है। FAILED कार्यों के लिए 0 लौटाता है (त्रुटि पर क्रेडिट की पुनः प्राप्ति होती है)।
Name
image_urls
Type
array of strings
Description
इस प्रोटोटाइप कार्य द्वारा उत्पन्न की गई अवधारणा छवि उम्मीदवारों के डाउनलोड करने योग्य URL। वर्तमान में एपीआई हमेशा ठीक एक उम्मीदवार लौटाती है; भविष्य के संशोधन कई उम्मीदवारों को बिना किसी ब्रेकिंग बदलाव के सतह पर ला सकते हैं, इसलिए फ़ील्ड एक एरे है।
द ब्रिक फिगर बिल्ड टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे Meshy ट्रैक करता है ताकि एक सफल प्रोटोटाइप टास्क से टेक्सचर्ड 3D ईंट फिगर उत्पन्न किया जा सके। यह वही इमेज से 3D पाइपलाइन का उपयोग करता है जिसे इमेज से 3D द्वारा चलाया गया है, इसलिए आउटपुट फील्ड्स उस एंडपॉइंट के टास्क ऑब्जेक्ट के समान हैं।
गुण
Name
id
Type
string
Description
कार्य का विशिष्ट पहचानकर्ता।
Name
type
Type
string
Description
कार्य का प्रकार। मान है creative-lab-brick-figure-build।
Name
name
Type
string
Description
कार्य का नाम जो कार्य के निर्माण के समय दिया गया था। यदि कोई नाम नहीं दिया गया था तो यह एक खाली स्ट्रिंग होगा।
Name
status
Type
string
Description
कार्य की स्थिति। संभावित मान हैं PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED।
Name
progress
Type
integer
Description
कार्य की प्रगति। यदि कार्य अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 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 ऑब्जेक्ट संदर्भ के लिए Errors देखें।
Name
consumed_credits
Type
integer
Description
इस कार्य द्वारा उपभोग किए गए क्रेडिट की संख्या। FAILED कार्यों के लिए 0 लौटाता है (असफलता पर क्रेडिट वापस किए जाते हैं)।
Name
prompt
Type
string
Description
ब्रिक फिगर निर्माण के लिए हमेशा खाली। साझा V2ImageTo3DTaskResponse आकार के साथ क्रॉस-एंडपॉइंट संगतता के लिए उपस्थित जिसे इमेज से 3D द्वारा उपयोग किया जाता है।
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 मॉडल के लिए डाउनलोड करने योग्य URL। ब्रिक फिगर निर्माण एक टेक्सचर किए हुए GLB के साथ-साथ पाइपलाइनों के लिए जो Wavefront OBJ को प्राथमिकता देते हैं, OBJ + MTL जोड़ी तैयार करता है। फ़ील्ड का आकार इमेज से 3D model_urls ऑब्जेक्ट का मेल करता है ताकि भविष्य के प्रारूप जोड़ने में बिना किसी तोड़-फोड़ के समायोजन किया जा सके।
Name
glb
Type
string
Description
टेक्सचर GLB फ़ाइल के लिए डाउनलोड करने योग्य URL।
Name
obj
Type
string
Description
Wavefront OBJ फ़ाइल के लिए डाउनलोड करने योग्य URL (ज्यामिति + UV)।
Name
mtl
Type
string
Description
OBJ सहायक MTL मटेरियल फ़ाइल के लिए डाउनलोड करने योग्य URL। obj और texture_urls[0].base_color से प्रविष्टि के साथ जोड़ी बनाएं।
Name
thumbnail_url
Type
string
Description
मॉडल फ़ाइल की थंबनेल छवि के लिए डाउनलोड करने योग्य URL।
Name
texture_urls
Type
array
Description
इस कार्य द्वारा उत्पन्न टेक्सचर URL ऑब्जेक्ट्स की एक सरणी। वर्तमान में एकल ऑब्जेक्ट में बेस रंग मानचित्र शामिल है।
Name
base_color
Type
string
Description
बेस रंग मानचित्र छवि के लिए डाउनलोड करने योग्य URL।