एक सोर्स फोटो को दो चरणों में एक बड़े सिर वाले विनाइल कलेक्टिबल 3D फिगर में बदलें:
प्रोटोटाइप आपकी इनपुट फोटो से एक स्टाइल्ड कॉन्सेप्ट इमेज जेनरेट करता है, फिर
बिल्ड उस कॉन्सेप्ट इमेज को एक टेक्सचर्ड 3D मॉडल में बदल देता है।
दोनों चरण input_task_id के माध्यम से लिंक होते हैं।
POST /openapi/creative-lab/vinyl-figure/v1/prototype
सोर्स फोटो से एक सिंगल vinyl-figure-style कॉन्सेप्ट इमेज जनरेट करें। रिटर्न किया गया task ID वही है जिसे आप build एंडपॉइंट को input_task_id के रूप में पास करते हैं। रिस्पॉन्स शेप के लिए
The Vinyl Figure Prototype Task Object
देखें।
पैरामीटर
Name
image_url
Type
string
आवश्यक
Description
Meshy के लिए बिग-हेड vinyl figure के रूप में stylize करने हेतु सोर्स फोटो। हम वर्तमान में .jpg, .jpeg, .png, और .webp फॉर्मैट सपोर्ट करते हैं।
इमेज प्रदान करने के दो तरीके हैं:
पब्लिकली एक्सेसिबल URL: एक URL जो पब्लिक इंटरनेट से एक्सेसिबल हो।
Data URI: इमेज का बेस64-एन्कोडेड 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 प्रॉपर्टी में नए बनाए गए vinyl 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 स्ट्रिंग malformed है।
कंटेंट फ्लैग किया गया: इनपुट इमेज को NSFW या इंटेलेक्चुअल प्रॉपर्टी moderation द्वारा फ्लैग किया गया था।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जांचें।
Name
402 - Payment Required
Description
इस task को पूरा करने के लिए अपर्याप्त क्रेडिट।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-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>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
एक सफल प्रोटोटाइप टास्क से फाइनल टेक्सचर्ड 3D वाइनिल फिगर जनरेट करें। बिल्ड
वही image-to-3D पाइपलाइन चलाता है जो
इमेज से 3D चलाता है, इसलिए रेस्पॉन्स ऑब्जेक्ट फॉर्मेट और
आउटपुट URL की सूची पूरी तरह मेल खाती है। रेस्पॉन्स शेप के लिए
The Vinyl Figure Build Task Object
देखें।
पैरामीटर
Name
input_task_id
Type
string
आवश्यक
Description
इस्ी OpenAPI एंडपॉइंट के माध्यम से बनाए गए प्रोटोटाइप टास्क का टास्क ID। प्रोटोटाइप को उसी API की से बनाया गया होना चाहिए, उसे SUCCEEDED तक पहुँचना चाहिए, और उसे ठीक एक कैंडिडेट इमेज प्रोड्यूस करनी चाहिए थी।
वेबऐप के माध्यम से बनाए गए प्रोटोटाइप टास्क स्वीकार नहीं किए जाते — बिल्ड एंडपॉइंट केवल POST /openapi/creative-lab/vinyl-figure/v1/prototype द्वारा प्रोड्यूस किए गए प्रोटोटाइप टास्क को स्वीकार करता है और किसी भी अन्य स्रोत को 404 के साथ अस्वीकार कर देता है।
Name
name
Type
string
Description
डिस्प्ले उद्देश्यों के लिए वैकल्पिक टास्क नाम। अधिकतम 100 अक्षर।
रिटर्न्स
रेस्पॉन्स की result प्रॉपर्टी में नए बनाए गए वाइनिल फिगर बिल्ड टास्क का टास्क id होता है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें जब तक टास्क SUCCEEDED तक न पहुँच जाए, फिर टेक्सचर्ड GLB को model_urls.glb से डाउनलोड करें (या अगर आपकी डाउनस्ट्रीम पाइपलाइन OBJ पसंद करती है तो OBJ + MTL जोड़ी को model_urls.obj और model_urls.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/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
किसी मान्य टास्क id के आधार पर प्रोटोटाइप या बिल्ड टास्क प्राप्त करें। URL पथ
टास्क के चरण से मेल खाना चाहिए — यदि किसी बिल्ड टास्क को
/prototype/:id के माध्यम से प्राप्त किया जाता है, तो 404 लौटता है, और इसका उल्टा भी लागू होता है।
किसी vinyl फिगर टास्क को कैंसिल करें। यदि टास्क अभी भी PENDING है, तो
क्रिएट-टाइम पर उपयोग किए गए क्रेडिट रिफंड कर दिए जाते हैं। जो टास्क पहले से ही
IN_PROGRESS हैं, उन्हें बिना रिफंड के कैंसिल किया जाता है (क्योंकि वर्कर पहले से ही
रिसोर्सेज़ खर्च कर रहा हो सकता है)। जो टास्क पहले से ही किसी अंतिम स्थिति
(SUCCEEDED, FAILED, CANCELED) पर पहुँच चुके हैं, उन्हें कैंसिल नहीं किया जा सकता।
URL पथ को टास्क के स्टेज से मेल खाना चाहिए — /prototype/:buildId पर
DELETE करने से 404 रिटर्न होता है।
पथ पैरामीटर्स
Name
id
Type
path
Description
कैंसिल किए जाने वाले vinyl फिगर टास्क के लिए यूनीक आइडेंटिफ़ायर।
रिटर्न
सफलता पर 204 No Content को खाली बॉडी के साथ रिटर्न करता है।
फेलियर मोड्स
Name
400 - Bad Request
Description
टास्क पहले से ही किसी अंतिम स्थिति में है और इसे कैंसिल नहीं किया जा सकता।
Name
404 - Not Found
Description
टास्क मौजूद नहीं है, किसी अन्य यूज़र से संबंधित है, या इसका स्टेज URL पथ से मेल नहीं खाता।
Server-Sent Events (SSE) के माध्यम से vinyl figure टास्क के लिए रीयल-टाइम अपडेट स्ट्रीम करें। URL पथ को टास्क के चरण से मेल खाना चाहिए — /prototype/:buildId/stream पर स्ट्रीम खोलने पर status_code: 404 के साथ एक ही event: error पेलोड emit होता है और स्ट्रीम बंद हो जाती है।
पैरामीटर्स
Name
id
Type
path
Description
स्ट्रीम करने के लिए vinyl figure टास्क का यूनीक पहचानकर्ता।
रिटर्न वैल्यू
यह Server-Sent Events के रूप में Vinyl Figure Prototype
या Vinyl Figure Build टास्क ऑब्जेक्ट्स की एक स्ट्रीम लौटाता है।
हर फ्रेम में उस चरण का पूरा टास्क ऑब्जेक्ट होता है — वही रूप जो Get एंडपॉइंट लौटाता है — इसलिए जब तक टास्क PENDING या IN_PROGRESS है, आउटपुट फ़ील्ड्स केवल अभी तक भरे नहीं गए होते हैं (null, [] या {}) और finished_atnull होता है।
किसी एक स्टेज के लिए आपके विनाइल फिगर टास्क की पेजिनेटेड सूची प्राप्त करें।
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 के माध्यम से
बिल्ड स्टेज में चेन किया जाता है।
Properties
Name
id
Type
string
Description
टास्क के लिए यूनीक आइडेंटिफायर। हालांकि हम इम्प्लीमेंटेशन डिटेल के रूप में टास्क ids के लिए एक k-sortable UUID का उपयोग करते हैं, आपको id के फॉर्मैट के बारे में कोई धारणा नहीं बनानी चाहिए।
Name
type
Type
string
Description
टास्क का प्रकार। वैल्यू creative-lab-vinyl-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
पूर्ववर्ती (preceding) टास्क की संख्या।
इस फील्ड की वैल्यू केवल तभी सार्थक होती है जब टास्क का स्टेटस 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 करता है,
इसलिए आउटपुट फ़ील्ड उस एंडपॉइंट के टास्क ऑब्जेक्ट की नकल करते हैं।
Properties
Name
id
Type
string
Description
टास्क के लिए यूनिक पहचानकर्ता।
Name
type
Type
string
Description
टास्क का प्रकार। इसका मान creative-lab-vinyl-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 मॉडल के लिए डाउनलोड करने योग्य URL। विनाइल फिगर बिल्ड एक टेक्सचर्ड 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
इस टास्क द्वारा जनरेट किए गए texture_urls ऑब्जेक्ट का एक ऐरे। वर्तमान में इसमें बेस कलर मैप वाला एक ही ऑब्जेक्ट शामिल है।