किसी सोर्स फोटो को दो चरणों में एक ब्रिक-स्टाइल कलेक्टिबल 3D मिनीफिगर में बदलें:
प्रोटोटाइप आपकी इनपुट फोटो से एक स्टाइल्ड कॉन्सेप्ट इमेज जनरेट करता है, फिर
बिल्ड उस कॉन्सेप्ट इमेज को एक टेक्सचर्ड 3D मॉडल में बदल देता है। दोनों चरण
input_task_id के माध्यम से लिंक किए गए हैं।
POST /openapi/creative-lab/brick-figure/v1/prototype
सोर्स फोटो से एक सिंगल brick-style कॉन्सेप्ट इमेज जनरेट करें। रिटर्न किया गया task ID वही होता है जिसे आप build
एंडपॉइंट को input_task_id के रूप में पास करते हैं। रिस्पॉन्स शेप के लिए
The Brick Figure Prototype Task Object
देखें।
पैरामीटर
Name
image_url
Type
string
आवश्यक
Description
Meshy को brick minifigure के रूप में स्टाइलाइज़ करने के लिए सोर्स फोटो। हम फिलहाल .jpg, .jpeg, .png, और .webp फॉर्मैट सपोर्ट करते हैं।
इमेज देने के दो तरीके हैं:
पब्लिकली एक्सेसिबल URL: एक ऐसा URL जो पब्लिक इंटरनेट से एक्सेसिबल हो।
Data URI: इमेज का base64-एन्कोडेड data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
डिस्प्ले पर्पस के लिए ऑप्शनल task नाम। अधिकतम 100 अक्षर।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
जब true सेट किया जाता है, तो prototype इमेज बैकग्राउंड हटाकर ट्रांसपेरेंट RGBA PNG के रूप में रिटर्न की जाती है, ताकि आप सब्जेक्ट को किसी भी बैकग्राउंड पर कंपोज़िट कर सकें।
रिटर्न वैल्यू
रिस्पॉन्स की result प्रॉपर्टी में नए बनाए गए brick figure prototype task की task id होती है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें, जब तक task SUCCEEDED तक न पहुंच जाए, फिर उस ID को build endpoint को 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
इस task को करने के लिए अपर्याप्त क्रेडिट।
Name
403 - Forbidden
Description
इनपुट इमेज को इंटेलेक्चुअल प्रॉपर्टी उल्लंघन के लिए फ्लैग किया गया था।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \-XPOST \-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 ब्रिक फिगर जनरेट करें। यह बिल्ड वही image-to-3D पाइपलाइन चलाता है जो
इमेज से 3D उपयोग करता है, इसलिए रिस्पॉन्स ऑब्जेक्ट का फॉर्मेट और आउटपुट URL की लिस्ट पूरी तरह से मेल खाती है। रिस्पॉन्स शेप के लिए
The Brick Figure Build Task Object देखें।
पैरामीटर
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 होता है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें जब तक टास्क SUCCEEDED तक न पहुँच जाए, फिर model_urls.glb से टेक्स्चर्ड 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-mode प्रोटोटाइप टास्क ही बिल्ड में चेन होते हैं)।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-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 लौटाता है, और इसका उल्टा भी सत्य है।
एक brick figure task को कैंसिल करें। अगर task अभी भी PENDING है, तो
क्रिएशन के समय इस्तेमाल हुए क्रेडिट रिफंड कर दिए जाते हैं। जो टास्क पहले से ही
IN_PROGRESS हैं, उन्हें बिना रिफंड के कैंसिल किया जाता है (हो सकता है वर्कर पहले से ही
रिसोर्सेज़ इस्तेमाल कर रहा हो)। जो टास्क पहले से ही किसी टर्मिनल स्टेट
(SUCCEEDED, FAILED, CANCELED) पर पहुँच चुके हैं, उन्हें कैंसिल नहीं किया जा सकता।
URL पाथ टास्क के स्टेज से मेल खाना चाहिए — /prototype/:buildId पर
DELETE404 रिटर्न करता है।
Path Parameters
Name
id
Type
path
Description
कैंसिल किए जाने वाले brick figure task के लिए यूनीक आइडेंटिफ़ायर।
Returns
सफलता पर खाली बॉडी के साथ 204 No Content रिटर्न करता है।
Failure Modes
Name
400 - Bad Request
Description
टास्क पहले से ही किसी टर्मिनल स्टेट में है और इसे कैंसिल नहीं किया जा सकता।
Name
404 - Not Found
Description
टास्क मौजूद नहीं है, किसी अलग यूज़र का है, या इसका स्टेज URL पाथ से मेल नहीं खाता।
Server-Sent Events (SSE) के ज़रिए ब्रिक फिगर टास्क के लिए रीयल-टाइम अपडेट स्ट्रीम करें।
URL पथ को टास्क के चरण से मेल खाना चाहिए — /prototype/:buildId/stream पर स्ट्रीम खोलने पर
status_code: 404 के साथ एक ही event: error पेलोड भेजा जाता है और स्ट्रीम बंद हो जाती है।
Parameters
Name
id
Type
path
Description
स्ट्रीम करने के लिए ब्रिक फिगर टास्क का यूनीक आइडेंटिफ़ायर।
Returns
यह Brick Figure Prototype
या Brick Figure Build टास्क ऑब्जेक्ट्स की एक स्ट्रीम
Server-Sent Events के रूप में लौटाता है। हर फ्रेम में उस चरण के लिए पूरा टास्क ऑब्जेक्ट होता है — वही आकार जो
Get एंडपॉइंट लौटाता है — इसलिए जब तक टास्क PENDING या IN_PROGRESS है, तब तक
आउटपुट फ़ील्ड्स बस अभी भरे नहीं गए होते हैं (null, [] या {}) और
finished_atnull होता है।
एक ही स्टेज के लिए अपने ब्रिक फिगर टास्क की एक पेजिनेटेड सूची प्राप्त करें। URL
पथ स्टेज का चयन करता है — /prototype प्रोटोटाइप टास्क लौटाता है; /build
बिल्ड टास्क लौटाता है। दूसरे स्टेज के टास्क किसी भी
रिस्पॉन्स में शामिल नहीं किए जाते।
Path Parameters
Name
stage
Type
path
आवश्यक
Description
या तो prototype या build। कलेक्शन केवल उन्हीं टास्क को लौटाता है
जिनका स्टेज URL से मेल खाता है — /prototype फ़ेच करने पर कभी भी
बिल्ड टास्क नहीं मिलते और इसका उल्टा भी लागू होता है।
Query Parameters
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 के माध्यम से बिल्ड स्टेज में चेन किया जाता है।
Properties
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
टास्क का progress। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी। एक बार टास्क सफल हो जाने पर, यह 100 हो जाएगी।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।
एक टाइमस्टैंप RFC 3339 स्टैंडर्ड के अनुसार, 1 जनवरी, 1970 UTC से बीते मिलीसेकंड की संख्या को दर्शाता है।
उदाहरण के लिए, शुक्रवार, 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
टास्क परिणाम की expiry होने का टाइमस्टैंप, मिलीसेकंड में।
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
इस प्रोटोटाइप टास्क द्वारा जेनरेट किए गए कॉन्सेप्ट इमेज उम्मीदवारों के लिए डाउनलोड करने योग्य URL। वर्तमान में API हमेशा ठीक एक उम्मीदवार लौटाता है; यह फ़ील्ड एक array है ताकि भविष्य के रिविज़न में बिना किसी ब्रेकिंग चेंज के कई उम्मीदवार सामने लाए जा सकें।
ब्रिक फिगर बिल्ड टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे 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
टास्क की 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 की साथी MTL मटेरियल फ़ाइल के लिए डाउनलोड करने योग्य URL। इसे obj और texture_urls[0].base_color से मिली प्रविष्टि के साथ जोड़ें।
Name
thumbnail_url
Type
string
Description
मॉडल फ़ाइल की थंबनेल इमेज के लिए डाउनलोड करने योग्य URL।
Name
texture_urls
Type
array
Description
इस टास्क द्वारा जनरेट किए गए टेक्सचर URL ऑब्जेक्ट्स का एक एरे। वर्तमान में इसमें बेस कलर मैप वाला एक ही ऑब्जेक्ट है।