एक स्रोत फोटो को दो चरणों में चिबी-शैली के संग्रहणीय 3D फिगर में बदलें:
प्रोटोटाइप आपके इनपुट फोटो से एक स्टाइलिश कॉन्सेप्ट इमेज उत्पन्न करता है, फिर
बिल्ड उस कॉन्सेप्ट इमेज को एक texture 3D मॉडल में बदल देता है। ये दोनों चरण
input_task_id के माध्यम से जुड़े होते हैं।
स्रोत फोटो से एक चिबी-शैली की अवधारणा छवि उत्पन्न करें। लौटाया गया टास्क ID वह है जिसे आप 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 वर्ण।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो प्रोटोटाइप छवि को एक पारदर्शी RGBA PNG के रूप में लौटाया जाता है जिसमें पृष्ठभूमि हटा दी जाती है, ताकि आप विषय को किसी भी पृष्ठभूमि पर संयोजित कर सकें।
रिटर्न्स
प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए फिगर प्रोटोटाइप टास्क का टास्क id होता है। एक टास्क प्राप्त करें एंडपॉइंट को पोल करें या स्ट्रीम की सदस्यता लें जब तक कि टास्क 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
आपने अपनी रेट लिमिट को पार कर लिया है।
अनुरोध
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/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>" }'
प्रतिक्रिया
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
प्रोटोटाइप उदाहरण
एक स्रोत पोर्ट्रेट के साथ शुरू करें, फिर बिल्ड चरण द्वारा उपयोग की गई प्रोटोटाइप छवि उत्पन्न करें।
एक सफल प्रोटोटाइप टास्क से अंतिम 3D टेक्सचर्ड फिगर उत्पन्न करें। बिल्ड उसी इमेज से 3D पाइपलाइन को चलाता है जैसे इमेज से 3D, इसलिए प्रतिक्रिया ऑब्जेक्ट प्रारूप और आउटपुट URLs की सूची बिल्कुल मेल खाती है। प्रतिक्रिया के आकार के लिए फिगर बिल्ड टास्क ऑब्जेक्ट देखें।
पैरामीटर
Name
input_task_id
Type
string
आवश्यक
Description
इस ही OpenAPI एंडपॉइंट के माध्यम से बनाए गए प्रोटोटाइप टास्क का टास्क ID। प्रोटोटाइप को उसी API की के साथ बनाया गया होना चाहिए, SUCCEEDED तक पहुंचा होना चाहिए, और बिल्कुल एक उम्मीदवार छवि उत्पन्न की होनी चाहिए।
वेबऐप के माध्यम से बनाए गए प्रोटोटाइप टास्क स्वीकार नहीं किए जाते हैं — बिल्ड एंडपॉइंट केवल POST /openapi/creative-lab/figure/v1/prototype द्वारा उत्पन्न प्रोटोटाइप टास्क को स्वीकार करता है और किसी अन्य स्रोत को 404 के साथ अस्वीकार करता है।
Name
name
Type
string
Description
प्रदर्शन उद्देश्यों के लिए वैकल्पिक टास्क नाम। अधिकतम 100 वर्ण।
रिटर्न्स
प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए फिगर बिल्ड टास्क का टास्क id होता है। एक टास्क प्राप्त करें एंडपॉइंट को पोल करें या स्ट्रीम की सदस्यता लें जब तक कि टास्क 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-मोड प्रोटोटाइप टास्क बिल्ड में चेन होते हैं)।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट को पार कर लिया है।
अनुरोध
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
प्रतिक्रिया
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
बिल्ड उदाहरण
बिल्ड टास्क चयनित प्रोटोटाइप छवि को एक डाउनलोड करने योग्य टेक्सचर्ड 3D मॉडल में बदल देता है।
एक वैध कार्य 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 (SSE) के माध्यम से एक फिगर टास्क के लिए वास्तविक समय अपडेट स्ट्रीम करें। URL पथ को टास्क के चरण से मेल खाना चाहिए — /prototype/:buildId/stream पर एक स्ट्रीम खोलने से status_code: 404 के साथ एकल event: error पेलोड उत्पन्न होता है और स्ट्रीम बंद हो जाती है।
पैरामीटर्स
Name
id
Type
path
Description
स्ट्रीम करने के लिए फिगर टास्क के लिए अद्वितीय पहचानकर्ता।
रिटर्न्स
Figure Prototype या Figure Build टास्क ऑब्जेक्ट्स को 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
कार्य के लिए अद्वितीय पहचानकर्ता। जबकि हम कार्य आईडी के लिए k-sortable UUID का उपयोग करते हैं, आपको आईडी के प्रारूप के बारे में कोई धारणा नहीं बनानी चाहिए।
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
कार्य की प्रगति। यदि कार्य अभी तक शुरू नहीं हुआ है, तो यह गुण 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 हमेशा एक उम्मीदवार लौटाता है; यह फ़ील्ड एक एरे है ताकि भविष्य के संशोधन बिना किसी ब्रेकिंग परिवर्तन के कई उम्मीदवारों को सतह पर ला सकें।
फिगर बिल्ड टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे Meshy ट्रैक करता है
एक सफल प्रोटोटाइप टास्क से एक टेक्सचरयुक्त 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
कार्य की प्रगति। यदि कार्य अभी तक शुरू नहीं हुआ है, तो यह गुण 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
फिगर बिल्ड के लिए हमेशा खाली। साझा 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 मॉडल के लिए डाउनलोड करने योग्य 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 ऑब्जेक्ट्स की एक श्रृंखला। वर्तमान में बेस कलर मैप के साथ एकल ऑब्जेक्ट होता है।