अपनी फ़ोटो को कस्टम फ्रिज मैग्नेट में बदलें — एक गोल-आयताकार रंगीकृत
डेप्थ रिलीफ़, जिसकी पीछे की सतह सपाट चुंबकीय होती है और जिसका आकार फ्रिज के लिए उपयुक्त होता है — दो
चरणों में: प्रोटोटाइप आपकी इनपुट
फ़ोटो से एक रंगीकृत कॉन्सेप्ट इमेज जनरेट करता है, फिर बिल्ड उस कॉन्सेप्ट इमेज को रिलीफ़ 3D मॉडल में बदलता है। ये
दो चरण input_task_id के माध्यम से जुड़े होते हैं।
POST /openapi/creative-lab/fridge-magnet/v1/prototype
स्रोत फ़ोटो से एकल रंगीन कॉन्सेप्ट इमेज जनरेट करें। लौटाई गई
टास्क ID वही है जिसे आप build एंडपॉइंट में 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 एंडपॉइंट को poll करें या stream को तब तक subscribe करें जब तक टास्क 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
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।
Request
POST
/openapi/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept imagecurl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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":"01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
सफल prototype टास्क से अंतिम 3D-प्रिंट योग्य फ्रिज मैग्नेट जनरेट करें।
बिल्ड prototype की रंगीन concept image पर depth-map relief pipeline चलाता है
और आपके माँगे गए फ़ॉर्मैट में एकल मेश artifact भेजता है। response shape के लिए
The Fridge Magnet Build Task Object देखें।
पैरामीटर
Name
input_task_id
Type
string
आवश्यक
Description
इसी OpenAPI एंडपॉइंट के ज़रिए बनाए गए prototype टास्क की task ID। prototype उसी API की से बनाया गया होना चाहिए, उसे SUCCEEDED तक पहुँचना चाहिए, और उसने ठीक एक candidate image बनाई होनी चाहिए।
webapp के ज़रिए बनाए गए prototype टास्क स्वीकार नहीं किए जाते — build एंडपॉइंट केवल POST /openapi/creative-lab/fridge-magnet/v1/prototype द्वारा बनाए गए prototype टास्क स्वीकार करता है और किसी भी अन्य स्रोत को 404 के साथ अस्वीकार करता है।
Name
name
Type
string
Description
display उद्देश्यों के लिए वैकल्पिक task name। अधिकतम 100 अक्षर।
options
relief ज्यामिति के लिए वैकल्पिक tuning पैरामीटर। हर field का एक उचित default है — केवल वे भेजें जिन्हें आप override करना चाहते हैं।
Name
badge_shape
Type
string
डिफ़ॉल्ट rounded-rect
Description
फ्रिज मैग्नेट की outline silhouette। उपलब्ध मान:
circle
rounded-rect (default)
hexagon
shield
star
Name
size_mm
Type
number
डिफ़ॉल्ट 60
Description
फ्रिज मैग्नेट के bounding square की edge length, मिलीमीटर में। Range: (0, 400].
Name
relief_height_mm
Type
number
डिफ़ॉल्ट 3.3
Description
base से ऊपर maximum relief height, मिलीमीटर में। Range: [0, 20].
Name
relief_offset_mm
Type
number
डिफ़ॉल्ट 0
Description
extrusion से पहले relief पर लागू vertical offset, मिलीमीटर में। Range: [0, 20].
Name
base_thickness_mm
Type
number
डिफ़ॉल्ट 2.0
Description
relief के पीछे flat base plate की thickness, मिलीमीटर में। फ्रिज मैग्नेट default एक अधिक मोटा 2 mm base है — यह मैग्नेट को फ्रिज पकड़ने के लिए पर्याप्त body देता है, बिना relief को नाज़ुक महसूस कराए। Range: [0, 20].
Name
has_closed_back
Type
boolean
डिफ़ॉल्ट true
Description
क्या फ्रिज मैग्नेट का पिछला हिस्सा closed surface के रूप में sealed है (वह side जिस पर आप magnet चिपकाते हैं)। open shell के लिए false पर set करें।
Name
relief_curve
Type
string
डिफ़ॉल्ट linear
Description
depth-map values को relief height पर map करने वाली transfer curve। उपलब्ध मान:
linear (default)
gamma
s-curve
Name
curve_param
Type
number
डिफ़ॉल्ट 1.0
Description
transfer curve के लिए shape पैरामीटर (केवल तब अर्थपूर्ण जब relief_curvegamma हो)। Range: (0, 10].
Name
invert_depth
Type
boolean
डिफ़ॉल्ट false
Description
depth-map interpretation को invert करें ताकि गहरे regions higher relief बनें।
Name
smoothing
Type
number
डिफ़ॉल्ट 0.24
Description
relief extraction से पहले depth map पर लागू smoothing strength। Range: [0, 10].
Name
relief_scale
Type
number
डिफ़ॉल्ट 1.0
Description
relief_height_mm के ऊपर लागू vertical scale multiplier। Range: (0, 10].
Name
depth_threshold
Type
number
डिफ़ॉल्ट 0.1
Description
depth-map values के लिए low-pass threshold; इससे नीचे की कोई भी चीज़ zero पर clamped होती है। Range: [0, 1].
Name
remove_background
Type
boolean
डिफ़ॉल्ट true
Description
reliefing से पहले prototype की concept image का background automatically remove करें।
Name
export_resolution
Type
integer
डिफ़ॉल्ट 512
Description
export के लिए उपयोग की गई मेश resolution। Range: [64, 2048].
output
वैकल्पिक wire-format selector। Default glb है।
Name
format
Type
string
डिफ़ॉल्ट glb
Description
build द्वारा लौटाया गया artifact bundle। उपलब्ध मान:
glb (default) — model_urls.glb के अंतर्गत एकल model.glb लौटाता है।
obj — model.obj + model.mtl + texture.png को zip करता है और bundle को model_urls.obj के अंतर्गत लौटाता है।
zip — generator द्वारा emit किए गए हर artifact को zip करता है और bundle को model_urls.bundle_zip के अंतर्गत लौटाता है।
Returns
response की result property में नए बनाए गए फ्रिज मैग्नेट build टास्क की task id होती है। task के SUCCEEDED तक पहुँचने तक Get a Task एंडपॉइंट को poll करें या stream को subscribe करें, फिर model_urls में single entry से artifact download करें।
Failure Modes
Name
400 - Bad Request
Description
request स्वीकार्य नहीं था। सामान्य कारण:
Missing parameter: input_task_id आवश्यक है।
Invalid UUID: input_task_id valid UUID नहीं है।
Parent not succeeded: referenced prototype टास्क अभी तक SUCCEEDED तक नहीं पहुँचा है।
No candidate: prototype टास्क सफल हुआ लेकिन उसने कोई candidate image नहीं बनाई।
Options out of range: options fields में से कोई अपने allowed range या enum set से बाहर था।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
404 - Not Found
Description
referenced prototype टास्क मौजूद नहीं है, किसी अलग user से संबंधित है, या webapp के ज़रिए बनाया गया था (केवल API-mode prototype टास्क build में chain होते हैं)।
मान्य टास्क id दिए जाने पर कोई प्रोटोटाइप या बिल्ड टास्क प्राप्त करें। URL पाथ
टास्क के चरण से मेल खाना चाहिए — /prototype/:id के माध्यम से प्राप्त किया गया बिल्ड टास्क
404 लौटाता है, और इसके विपरीत भी।
फ्रिज मैग्नेट कार्य रद्द करें। यदि कार्य अभी भी PENDING है, तो निर्माण-समय पर
खर्च किए गए क्रेडिट वापस कर दिए जाते हैं। जो कार्य पहले से ही
IN_PROGRESS हैं, उन्हें बिना रिफंड के रद्द किया जाता है (वर्कर पहले से ही
रिसोर्सेज़ का उपयोग कर रहा हो सकता है)। जो कार्य पहले ही अंतिम स्थिति तक पहुँच चुके हैं
(SUCCEEDED, FAILED, CANCELED) उन्हें रद्द नहीं किया जा सकता।
URL पाथ कार्य के चरण से मेल खाना चाहिए — /prototype/:buildId पर
DELETE करने से 404 लौटता है।
पाथ पैरामीटर
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
स्ट्रीम करने के लिए फ्रिज मैग्नेट टास्क का विशिष्ट पहचानकर्ता।
रिटर्न
फ्रिज मैग्नेट प्रोटोटाइप
या फ्रिज मैग्नेट बिल्ड टास्क ऑब्जेक्ट की स्ट्रीम
Server-Sent Events के रूप में लौटाता है। PENDING या IN_PROGRESS टास्क के लिए, रिस्पॉन्स
स्ट्रीम में केवल आवश्यक progress और status फ़ील्ड शामिल होंगे।
// Error event example (wrong stage or task not found)event: errordata: {"status_code": 404,"message": "Task not found"}// Message event examples illustrate task progress.// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","progress": 0,"status": "PENDING"}event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","type": "creative-lab-fridge-magnet-build","status": "SUCCEEDED","progress": 100,"created_at": 1729543250000,"started_at": 1729543258000,"finished_at": 1729543285000,"expires_at": 1729802485000,"task_error": null,"consumed_credits": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***" }}
किसी एक चरण के लिए अपने फ्रिज मैग्नेट कार्यों की पेजिनेशन वाली सूची प्राप्त करें। URL
पाथ चरण चुनता है — /prototype prototype कार्य लौटाता है; /build
build कार्य लौटाता है। दूसरे चरण के कार्य किसी भी
response में शामिल नहीं होते हैं।
पाथ पैरामीटर
Name
stage
Type
path
आवश्यक
Description
या तो prototype या build। संग्रह केवल वे कार्य लौटाता है
जिनका चरण URL से मेल खाता है — /prototype fetch करने पर कभी भी
build कार्य नहीं लौटते और इसके उलट भी।
क्वेरी पैरामीटर
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
टास्क के लिए अद्वितीय पहचानकर्ता। यद्यपि हम implementation detail के रूप में टास्क ids के लिए k-sortable UUID का उपयोग करते हैं, आपको id के फ़ॉर्मैट के बारे में कोई भी अनुमान नहीं लगाना चाहिए।
Name
type
Type
string
Description
टास्क का प्रकार। वैल्यू creative-lab-fridge-magnet-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
इस टास्क द्वारा consume किए गए क्रेडिट की संख्या। यह तब मौजूद होता है जब टास्क स्थिति PENDING, IN_PROGRESS, या SUCCEEDED हो। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।
Name
image_urls
Type
array of strings
Description
इस प्रोटोटाइप टास्क द्वारा जेनरेट किए गए कॉन्सेप्ट इमेज candidates के लिए डाउनलोड करने योग्य URLs। वर्तमान में API हमेशा ठीक एक candidate लौटाता है; फ़ील्ड एक array है ताकि भविष्य के revisions breaking change के बिना कई candidates दिखा सकें।
फ्रिज मैग्नेट बिल्ड टास्क ऑब्जेक्ट एक वर्क यूनिट है, जिसे Meshy ट्रैक करता है ताकि
एक सफल प्रोटोटाइप टास्क से अंतिम 3D फ्रिज मैग्नेट मेश जेनरेट किया जा सके। यह
बिल्ड प्रोटोटाइप की कॉन्सेप्ट इमेज पर डेप्थ-मैप रिलीफ पाइपलाइन चलाता है और
कॉलर द्वारा अनुरोधित फॉर्मेट में एकल मेश आर्टिफैक्ट प्रकाशित करता है।
प्रॉपर्टीज़
Name
id
Type
string
Description
टास्क के लिए अद्वितीय पहचानकर्ता।
Name
type
Type
string
Description
टास्क का प्रकार। मान creative-lab-fridge-magnet-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
model_urls
Type
object
Description
जेनरेट किए गए आर्टिफैक्ट के लिए डाउनलोड किए जा सकने वाले URL, आर्टिफैक्ट नाम के आधार पर कुंजीबद्ध। हमेशा ठीक एक प्रविष्टि होती है — बिल्ड अनुरोध के output.format के माध्यम से अनुरोधित फ़ॉर्मैट। कुंजी अनुरोधित फ़ॉर्मैट से मेल खाती है:
Name
glb
Type
string
Description
GLB फ़ाइल के लिए डाउनलोड किया जा सकने वाला URL। तब मौजूद होता है जब output.formatglb था (डिफ़ॉल्ट)।
Name
obj
Type
string
Description
model.obj, model.mtl, और texture.png वाली zip बंडल के लिए डाउनलोड किया जा सकने वाला URL। तब मौजूद होता है जब output.formatobj था।
Name
bundle_zip
Type
string
Description
जेनरेटर द्वारा उत्सर्जित हर आर्टिफैक्ट की zip बंडल के लिए डाउनलोड किया जा सकने वाला URL। तब मौजूद होता है जब output.formatzip था।