Creative Lab फ्रिज मैग्नेट API

एक फोटो को दो चरणों में रंगीन रिलीफ और सपाट पीठ वाले 3D-प्रिंट करने योग्य फ्रिज मैग्नेट में बदलें। एक प्रोटोटाइप टास्क फोटो से एक रंगीन कॉन्सेप्ट इमेज जनरेट करता है। एक बिल्ड टास्क उस इमेज को एक रिलीफ 3D मॉडल में बदल देता है, और प्रोटोटाइप टास्क की ID को input_task_id के रूप में लेता है।

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

एक फ्रिज मैग्नेट prototype टास्क बनाएं

एक फोटो से एक रंगीन कॉन्सेप्ट इमेज जनरेट करता है। 3D मॉडल बनाने के लिए, इस टास्क की ID को input_task_id के रूप में build एंडपॉइंट को पास करें। टास्क के फ़ील्ड्स के लिए, The Fridge Magnet prototype task object देखें।

Request

POST

/openapi/creative-lab/fridge-magnet/v1/prototype

# Stage 1: generate a colorized fridge magnet concept image
curl 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.

Source landscape photo used as the Creative Lab Fridge Magnet input — Prototype input

Creative Lab Fridge Magnet prototype output generated from the source photo — Prototype output

पैरामीटर

Name
image_url
Type
string
आवश्यक
Description
वह फोटो जिसे फ्रिज मैग्नेट कॉन्सेप्ट इमेज में बदलना है, एक पब्लिक URL या Data URI के रूप में (data:image/jpeg;base64,<your base64-encoded image data>)।
इमेज अधिकतम 20 MB की JPG, JPEG, PNG, या WebP फ़ाइल होनी चाहिए।
Name
name
Type
string
Description
टास्क के लिए एक नाम, अधिकतम 100 कैरेक्टर तक। यह टास्क के name फ़ील्ड में वापस आता है। इससे लंबा नाम 400 रिटर्न करता है।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
prototype इमेज से बैकग्राउंड हटाना है या नहीं। true एक पारदर्शी RGBA PNG रिटर्न करता है जो पूरे मैग्नेट को बनाए रखता है, ताकि आप इसे किसी भी बैकग्राउंड पर रख सकें। build भी बिना बैकग्राउंड वाली इमेज से ही शुरू होता है। अगर Meshy बैकग्राउंड नहीं हटा पाता, तो यह इमेज को उसके बैकग्राउंड के साथ रिटर्न करता है, और टास्क फिर भी सफल होता है।
build का remove_background विकल्प अलग है।

रिटर्न वैल्यू

result फ़ील्ड में नए prototype टास्क की ID होती है। टास्क प्राप्त करें या इसे स्ट्रीम करें जब तक कि status SUCCEEDED न हो जाए। फिर ID को input_task_id के रूप में build एंडपॉइंट को पास करें।

विफलता के तरीके

Name
400 - Bad Request
Description
रिक्वेस्ट चल नहीं सकती। उदाहरण के लिए:
- image_url गायब है।
- इमेज JPG, JPEG, PNG, या WebP फ़ाइल नहीं है।
- इमेज बहुत छोटी है, 20 MB से अधिक है, या अधिकतम पिक्सेल संख्या से अधिक है।
- Meshy इमेज डाउनलोड नहीं कर सकता, उदाहरण के लिए क्योंकि URL 404 रिटर्न करता है या टाइमआउट हो जाता है।
- Data URI वैध base64 नहीं है।
- इमेज को NSFW के रूप में फ़्लैग किया गया था।
एरर मैसेज बताता है कि उसे क्या समस्या मिली। रिक्वेस्ट ठीक करें, फिर इसे फिर से भेजें।
Name
401 - Unauthorized
Description
API की गायब है या अमान्य है। Authorization हेडर जांचें।
Name
402 - Payment Required
Description
इनमें से कोई एक लागू होता है:
- अकाउंट में पर्याप्त क्रेडिट नहीं हैं।
- API की, वर्कस्पेस, या सदस्य अपनी क्रेडिट सीमा तक पहुंच गया है।
- अकाउंट फ्री प्लान पर है।
अपने क्रेडिट और प्लान की जांच करें, फिर दोबारा कोशिश करें।
Name
403 - Forbidden
Description
आपकी टीम ने IP Filtering चालू कर रखी है, और Meshy ने थर्ड-पार्टी इंटेलेक्चुअल प्रॉपर्टी के लिए इमेज को फ़्लैग किया है। एक ऐसी इमेज भेजें जिसे इस्तेमाल करने का आपको अधिकार है।
Name
429 - Too Many Requests
Description
इनमें से एक सीमा पहुंच गई थी:
- आपने अपनी रेट लिमिट से अधिक रिक्वेस्ट भेजीं। कुछ सेकंड प्रतीक्षा करें, फिर दोबारा कोशिश करें। रेट लिमिट देखें।
- आपके बहुत सारे टास्क क्यू में हैं या चल रहे हैं। कुछ के समाप्त होने की प्रतीक्षा करें, फिर दोबारा कोशिश करें।
- बिना क्रेडिट के अनलिमिटेड प्लान पर, आप बिना क्रेडिट के चलने वाले टास्क की संख्या तक पहुंच गए हैं। किसी टास्क के समाप्त होने की प्रतीक्षा करें, या क्रेडिट जोड़ें।
Name
500 - Internal Server Error
Description
Meshy को एक सर्वर एरर मिला, उदाहरण के लिए क्योंकि वह इमेज पर इंटेलेक्चुअल प्रॉपर्टी चेक नहीं चला सका। Meshy टास्क नहीं बनाता, और उसके द्वारा चार्ज किए गए किसी भी क्रेडिट को रिफंड करता है। रिक्वेस्ट को दोबारा कोशिश करें।

POST/openapi/creative-lab/fridge-magnet/v1/build

फ्रिज मैग्नेट बिल्ड टास्क बनाएँ

एक सफल प्रोटोटाइप टास्क से 3D-प्रिंट करने योग्य फ्रिज मैग्नेट जनरेट करता है। Meshy प्रोटोटाइप की कॉन्सेप्ट इमेज को एक डेप्थ-मैप रिलीफ में बदलता है, और आपके चुने हुए फॉर्मेट में एक मॉडल फ़ाइल लौटाता है। टास्क के फ़ील्ड्स के लिए, देखें The Fridge Magnet build task object।

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}

Build example

The build task turns the selected prototype image into a 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

पैरामीटर

Name
input_task_id
Type
string
आवश्यक
Description
बिल्ड करने के लिए प्रोटोटाइप टास्क की ID। यह आपके अकाउंट द्वारा POST /openapi/creative-lab/fridge-magnet/v1/prototype से बनाया गया टास्क होना चाहिए, जिसका स्टेटस SUCCEEDED हो।
अगर ID आपके API से बनाए गए फ्रिज मैग्नेट प्रोटोटाइप टास्क में से किसी से मेल नहीं खाती, तो यह 404 लौटाता है, जिसमें वेब ऐप में बनाया गया प्रोटोटाइप भी शामिल है।
Name
name
Type
string
Description
टास्क के लिए एक नाम, 100 कैरेक्टर तक। यह टास्क के name फ़ील्ड में वापस आता है। इससे लंबा नाम 400 लौटाता है।

`options`

रिलीफ के आकार के लिए वैकल्पिक सेटिंग्स। हर फ़ील्ड की एक डिफ़ॉल्ट वैल्यू है, इसलिए केवल उन्हीं को भेजें जिन्हें आप बदलना चाहते हैं। किसी फ़ील्ड की रेंज से बाहर की वैल्यू 400 लौटाती है।

Name
badge_shape
Type
string
डिफ़ॉल्ट rounded-rect
Description
मैग्नेट की आउटलाइन जब Meshy इसे सब्जेक्ट से ट्रेस नहीं करता। Meshy इसका उपयोग तब करता है जब remove_background false हो, या जब वह सब्जेक्ट की आउटलाइन नहीं ढूंढ पाता।
उपलब्ध वैल्यूज़:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
डिफ़ॉल्ट 60
Description
मैग्नेट के बाउंडिंग स्क्वायर की एज लेंथ, मिलीमीटर में, 400 तक। 0 डिफ़ॉल्ट का उपयोग करता है।
Name
relief_height_mm
Type
number
डिफ़ॉल्ट 3.3
Description
बेस के ऊपर रिलीफ की अधिकतम ऊँचाई, मिलीमीटर में, 0 से 20 तक।
Name
relief_offset_mm
Type
number
डिफ़ॉल्ट 0
Description
रिलीफ को कितना नीचे करना है, मिलीमीटर में, 0 से 20 तक। Meshy इसे रिलीफ की ऊँचाई से हर जगह घटाता है, बेस तक।
Name
base_thickness_mm
Type
number
डिफ़ॉल्ट 2.0
Description
रिलीफ के पीछे फ्लैट बेस प्लेट की मोटाई, मिलीमीटर में, 0 से 20 तक। डिफ़ॉल्ट 2 mm बेस मैग्नेट को फ्रिज पर पकड़ के लिए पर्याप्त बॉडी देता है, ताकि रिलीफ कमज़ोर न लगे।
Name
has_closed_back
Type
boolean
डिफ़ॉल्ट true
Description
मैग्नेट के पीछे के हिस्से को बंद करना है या नहीं, जिस साइड पर आप मैग्नेट चिपकाते हैं। false पीछे के हिस्से को खुला छोड़ता है, एक शेल के रूप में।
Name
relief_curve
Type
string
डिफ़ॉल्ट linear
Description
वह कर्व जो डेप्थ-मैप वैल्यूज़ को रिलीफ हाइट में मैप करता है।
उपलब्ध वैल्यूज़:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
डिफ़ॉल्ट 1.0
Description
कर्व की स्ट्रेंथ, 10 तक। gamma और s-curve कर्व इसका उपयोग करते हैं, और linear इसे नज़रअंदाज़ करता है। 0 डिफ़ॉल्ट का उपयोग करता है।
Name
invert_depth
Type
boolean
डिफ़ॉल्ट false
Description
डेप्थ मैप को इन्वर्ट करना है या नहीं, ताकि गहरे क्षेत्र अधिक ऊँची रिलीफ बन जाएँ।
Name
smoothing
Type
number
डिफ़ॉल्ट 0.24
Description
Meshy द्वारा रिलीफ बनाने से पहले डेप्थ मैप को कितना स्मूथ करना है, 0 से 10 तक।
Name
relief_scale
Type
number
डिफ़ॉल्ट 1.0
Description
आउटलाइन के अंदर, केंद्र के बारे में, रिलीफ और इसके टेक्सचर को कितना ज़ूम करना है, 10 तक। 1 से अधिक वैल्यू सब्जेक्ट को बड़ा करती है, और 1 से कम वैल्यू इसे छोटा करती है। यह रिलीफ की ऊँचाई नहीं बदलता। 0 डिफ़ॉल्ट का उपयोग करता है।
Name
depth_threshold
Type
number
डिफ़ॉल्ट 0.1
Description
वह डेप्थ-मैप वैल्यू जिसके नीचे Meshy डेप्थ को ज़ीरो पर सेट करता है, 0 से 1 तक।
Name
remove_background
Type
boolean
डिफ़ॉल्ट true
Description
मैग्नेट की आउटलाइन को सब्जेक्ट से ट्रेस करना है या नहीं, ताकि मैग्नेट सब्जेक्ट के आकार का अनुसरण करे। false इसकी जगह badge_shape आउटलाइन का उपयोग करता है। Meshy badge_shape का उपयोग तब भी करता है जब वह सब्जेक्ट की आउटलाइन नहीं ढूंढ पाता।
यह प्रोटोटाइप के remove_background पैरामीटर से अलग है, जो सेट करता है कि प्रोटोटाइप इमेज का बैकग्राउंड ट्रांसपेरेंट है या नहीं।
Name
export_resolution
Type
integer
डिफ़ॉल्ट 512
Description
एक्सपोर्ट किए गए मॉडल का मेश रिज़ॉल्यूशन, 64 से 512 तक। Meshy ज्यामिति को 512-पिक्सेल डेप्थ मैप से बनाता है, इसलिए एक फाइनर मेश डिटेल जोड़े बिना फ़ेस जोड़ेगा। 0 डिफ़ॉल्ट का उपयोग करता है।

`output`

वैकल्पिक। बिल्ड द्वारा लौटाए जाने वाले फ़ाइल फॉर्मेट को सेट करता है।

Name
format
Type
string
डिफ़ॉल्ट glb
Description
बिल्ड द्वारा लौटाया जाने वाला फ़ाइल फॉर्मेट।
उपलब्ध वैल्यूज़:
- glb: एक model.glb फ़ाइल, model_urls.glb में
- obj: model.obj, model.mtl, और texture.png वाली एक zip फ़ाइल, model_urls.obj में
- zip: Meshy द्वारा जनरेट की गई हर फ़ाइल वाली एक zip फ़ाइल, model_urls.bundle_zip में

रिटर्न वैल्यूज़

result फ़ील्ड में नए बिल्ड टास्क की ID होती है। टास्क प्राप्त करें या इसे स्ट्रीम करें जब तक status, SUCCEEDED न हो जाए। फिर model_urls में मौजूद एकमात्र एंट्री से फ़ाइल डाउनलोड करें।

फ़ेल्योर मोड्स

Name
400 - Bad Request
Description
रिक्वेस्ट चल नहीं सकती। उदाहरण के लिए:
- input_task_id गायब है या वैध टास्क ID नहीं है।
- प्रोटोटाइप टास्क का स्टेटस SUCCEEDED नहीं है। अगर यह अभी भी चल रहा है, तो प्रतीक्षा करें और फिर से कोशिश करें। अगर यह फेल हुआ या कैंसल किया गया, तो एक नया प्रोटोटाइप टास्क बनाएँ।
- प्रोटोटाइप टास्क सफल हुआ लेकिन उसमें कोई इमेज नहीं है। एक नया प्रोटोटाइप टास्क बनाएँ।
- कोई options फ़ील्ड अपनी रेंज से बाहर है या उपलब्ध वैल्यू नहीं है।
एरर मैसेज बताता है कि कौन सी समस्या पाई गई।
Name
401 - Unauthorized
Description
API की गायब है या अमान्य है। Authorization हेडर जाँचें।
Name
402 - Payment Required
Description
इनमें से कोई एक लागू होता है:
- अकाउंट में पर्याप्त क्रेडिट नहीं हैं।
- API की, वर्कस्पेस, या मेंबर अपनी क्रेडिट लिमिट तक पहुँच गया।
- अकाउंट फ्री प्लान पर है।
अपने क्रेडिट और प्लान की जाँच करें, फिर फिर से कोशिश करें।
Name
404 - Not Found
Description
input_task_id आपके अकाउंट द्वारा API से बनाए गए किसी भी फ्रिज मैग्नेट प्रोटोटाइप टास्क से मेल नहीं खाता। वेब ऐप में बनाया गया प्रोटोटाइप भी 404 लौटाता है। प्रोटोटाइप क्रिएट रिस्पॉन्स से result ID भेजें।
Name
429 - Too Many Requests
Description
इनमें से एक लिमिट तक पहुँच गई:
- आपने अपनी रेट लिमिट से अधिक रिक्वेस्ट भेजीं। कुछ सेकंड प्रतीक्षा करें, फिर फिर से कोशिश करें। देखें Rate limits।
- आपके बहुत अधिक टास्क कतार में हैं या चल रहे हैं। कुछ के पूरे होने की प्रतीक्षा करें, फिर फिर से कोशिश करें।
- बिना क्रेडिट के अनलिमिटेड प्लान पर, आप बिना क्रेडिट के चल सकने वाले टास्कों की संख्या तक पहुँच गए। किसी टास्क के पूरे होने की प्रतीक्षा करें, या क्रेडिट जोड़ें।

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Get a Fridge Magnet task

यह एक प्रोटोटाइप या बिल्ड टास्क लौटाता है। पाथ को टास्क के स्टेज से मेल खाना चाहिए। /prototype/:id के ज़रिए रिक्वेस्ट किया गया बिल्ड टास्क 404 लौटाता है, और /build/:id के ज़रिए रिक्वेस्ट किया गया प्रोटोटाइप टास्क भी ऐसा ही करता है।

फ़ील्ड्स के लिए, देखें The Fridge Magnet prototype task object और The Fridge Magnet build task object।

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

पैरामीटर्स

Name
id
Type
path
Description
क्रिएट रिस्पॉन्स से मिला टास्क ID।

रिटर्न

prototype task object या build task object, पाथ में दिए स्टेज के अनुसार।

विफलता के तरीके

Name
400 - Bad Request
Description
id एक मान्य टास्क ID नहीं है। क्रिएट रिस्पॉन्स से मिला result ID भेजें।
Name
403 - Forbidden
Description
आपकी टीम में IP Filtering चालू है, और Meshy ने प्रोटोटाइप टास्क की इमेज को थर्ड-पार्टी इंटेलेक्चुअल प्रॉपर्टी के लिए फ़्लैग किया है। बिल्ड टास्क और Enterprise प्लान वाली टीमों को यह एरर नहीं मिलती। ऐसी इमेज से प्रोटोटाइप टास्क बनाएं जिसका उपयोग करने का अधिकार आपके पास हो।
Name
404 - Not Found
Description
इस ID का कोई फ्रिज मैग्नेट टास्क आपके अकाउंट में नहीं है, या टास्क का स्टेज पाथ से मेल नहीं खाता। ID जांचें, और टास्क से मेल खाने के लिए /prototype या /build का उपयोग करें।
Name
500 - Internal Server Error
Description
Meshy इंटेलेक्चुअल प्रॉपर्टी चेक नहीं चला सका। रिक्वेस्ट को फिर से प्रयास करें।

DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

फ्रिज मैग्नेट टास्क को डिलीट करें

एक फ्रिज मैग्नेट टास्क को कैंसिल करता है। PENDING टास्क को कैंसिल करने पर उसके क्रेडिट रिफंड हो जाते हैं। एक IN_PROGRESS टास्क बिना रिफंड के कैंसिल किया जाता है, क्योंकि एक वर्कर पहले ही उस पर काम शुरू कर चुका होता है। अंतिम स्टेटस (SUCCEEDED, FAILED, या CANCELED) वाले टास्क को कैंसिल नहीं किया जा सकता।

पाथ का टास्क के स्टेज से मेल खाना ज़रूरी है। उदाहरण के लिए, किसी बिल्ड टास्क की ID के साथ /prototype/:id पर DELETE करने से 404 मिलता है।

Request

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

पाथ पैरामीटर

Name
id
Type
path
Description
कैंसिल किए जाने वाले टास्क की ID।

रिटर्न

204 No Content खाली बॉडी के साथ।

फेलियर मोड

Name
400 - Bad Request
Description
इनमें से कोई एक लागू होता है:
- id एक वैध टास्क ID नहीं है। क्रिएट रिस्पॉन्स से मिली result ID भेजें।
- टास्क पहले से ही अंतिम स्टेटस (SUCCEEDED, FAILED, या CANCELED) में है, इसलिए इसे कैंसिल नहीं किया जा सकता।
Name
404 - Not Found
Description
इस ID वाला कोई फ्रिज मैग्नेट टास्क आपके अकाउंट से संबंधित नहीं है, या टास्क का स्टेज पाथ से मेल नहीं खाता। ID जांचें, और टास्क से मेल खाने के लिए /prototype या /build का उपयोग करें।

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

एक Fridge Magnet टास्क को स्ट्रीम करें

एक Fridge Magnet टास्क के अपडेट्स को Server-Sent Events (SSE) के रूप में स्ट्रीम करता है। पाथ को टास्क के स्टेज से मेल खाना चाहिए। अगर ऐसा नहीं होता, उदाहरण के लिए किसी build टास्क की ID /prototype/:id/stream पर, तो स्ट्रीम एक error ईवेंट भेजती है जिसमें status_code: 404 होता है, और फिर बंद हो जाती है।

Request

GET

/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

पैरामीटर्स

Name
id
Type
path
Description
क्रिएट रिस्पॉन्स से प्राप्त टास्क ID।

रिटर्न वैल्यू

prototype या build टास्क ऑब्जेक्ट्स की एक स्ट्रीम। प्रत्येक ईवेंट में पूरा टास्क ऑब्जेक्ट होता है, ठीक वैसे ही जैसे Get a Fridge Magnet task इसे रिटर्न करता है। जब तक टास्क PENDING या IN_PROGRESS स्थिति में होता है, तब तक इसके आउटपुट फ़ील्ड्स खाली रहते हैं (null, [], या {}), और finished_at null होता है।

अगर IP Filtering टास्क के परिणाम को ब्लॉक करती है, तो स्ट्रीम उसकी जगह एक error ईवेंट भेजती है, जिसमें वही status_code होता है जो एक get रिक्वेस्ट रिटर्न करती।

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

फ्रिज मैग्नेट टास्क सूचीबद्ध करें

यह आपके फ्रिज मैग्नेट टास्क को एक स्टेज के, एक बार में एक पेज के हिसाब से लौटाता है। पाथ स्टेज का चयन करता है। /prototype केवल prototype टास्क लौटाता है, और /build केवल build टास्क लौटाता है।

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Path parameters

Name
stage
Type
path
आवश्यक
Description
सूचीबद्ध करने के लिए स्टेज, prototype या build।

Query parameters

Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
लौटाने के लिए पेज, 1 से 255 तक। 0 पहला पेज लौटाता है। 0 से 255 के बाहर का मान 400 लौटाता है।
Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
प्रति पेज टास्क की संख्या, अधिकतम 100। 101 से 255 तक का मान 100 टास्क लौटाता है, और 0 डिफ़ॉल्ट मान का उपयोग करता है। 0 से 255 के बाहर का मान 400 लौटाता है।
Name
sort_by
Type
string
डिफ़ॉल्ट -created_at
Description
सॉर्ट करने का क्रम।
उपलब्ध मान:
- -created_at: सबसे नया पहले
- +created_at: सबसे पुराना पहले

Returns

prototype task objects या build task objects की एक array, जो पाथ में दिए गए स्टेज से मेल खाती है।

फ्रिज मैग्नेट prototype task object

एक prototype task किसी फ़ोटो से एक रंगीन concept image जनरेट करता है। इमेज को 3D मॉडल में बदलने के लिए, task की ID को build endpoint में input_task_id के रूप में पास करें।

Properties

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
टास्क ID। इसके फॉर्मेट पर भरोसा न करें।
Name
type
Type
string
Description
टास्क का प्रकार, हमेशा creative-lab-fridge-magnet-prototype।
Name
name
Type
string
Description
वह name जो आपने टास्क बनाते समय भेजा था, या "" यदि आपने कोई नहीं भेजा।
Name
status
Type
string
Description
टास्क की स्थिति।
उपलब्ध मान:
- PENDING: कतार में प्रतीक्षारत
- IN_PROGRESS: परिणाम जनरेट हो रहा है
- SUCCEEDED: अंतिम, परिणाम सहित
- FAILED: अंतिम, कारण task_error में
- CANCELED: अंतिम, बिना किसी परिणाम के
Name
progress
Type
integer
Description
पूरे हुए काम का प्रतिशत, 0 से 100 तक। जब तक टास्क शुरू नहीं होता यह 0 रहता है और सफल होने पर 100 हो जाता है।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का समय, Unix मिलीसेकंड में।
Name
started_at
Type
timestamp
Description
जिस समय किसी worker ने टास्क शुरू किया, Unix मिलीसेकंड में। तब तक null रहता है।
Name
finished_at
Type
timestamp
Description
जिस समय टास्क किसी अंतिम स्थिति पर पहुँचा, Unix मिलीसेकंड में। तब तक null रहता है।
Name
expires_at
Type
timestamp
Description
जिस समय टास्क का परिणाम expire होता है, Unix मिलीसेकंड में। यह finished_at के 3 दिन बाद होता है, या टास्क के पूरा होने तक created_at के 3 दिन बाद। Enterprise अकाउंट्स के लिए, जो API परिणामों को अनिश्चित काल तक रखते हैं, यह लगभग 100 वर्ष बाद होता है। देखें Asset retention।
Name
preceding_tasks
Type
integer
Description
PENDING रहते हुए कतार में टास्क की स्थिति। 1 का अर्थ है कि यह अगला शुरू होगा। टास्क के कतार से निकलने के बाद 0, और list परिणामों में हमेशा 0।
Name
task_error
Type
object
Description
टास्क क्यों विफल हुआ। null जब तक status, FAILED न हो। देखें एरर।
Name
consumed_credits
Type
integer
Description
किसी भी रिफंड के बाद, टास्क के लिए चार्ज किए गए क्रेडिट की संख्या। जो रिक्वेस्ट एरर लौटाती है उस पर चार्ज नहीं लगता। विफल टास्क के लिए यह 0 होता है, क्योंकि Meshy इसे रिफंड कर देता है। कैंसिल करने पर टास्क का रिफंड तभी मिलता है जब वह PENDING स्थिति में हो। यदि Meshy चार्ज नहीं पढ़ पाता, तो get या stream रिस्पॉन्स में यह फ़ील्ड शामिल नहीं होता, और list रिक्वेस्ट 500 लौटाती है। ऐसे में, रिक्वेस्ट को फिर से प्रयास करें।
Name
image_urls
Type
array of strings
Description
concept image के लिए डाउनलोड URLs। टास्क सफल होने के बाद array में एक URL होता है, और तब तक यह खाली रहता है।

फ्रिज मैग्नेट बिल्ड टास्क ऑब्जेक्ट

एक बिल्ड टास्क एक सफल प्रोटोटाइप टास्क से 3D फ्रिज मैग्नेट जनरेट करता है। यह आपके अनुरोध किए गए फॉर्मेट में एक मॉडल फ़ाइल लौटाता है।

Properties

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
टास्क ID। इसके फॉर्मेट पर भरोसा न करें।
Name
type
Type
string
Description
टास्क का प्रकार, हमेशा creative-lab-fridge-magnet-build।
Name
name
Type
string
Description
name जो आपने टास्क बनाते समय भेजा था, या "" यदि आपने कोई नहीं भेजा।
Name
status
Type
string
Description
टास्क की स्थिति।
उपलब्ध मान:
- PENDING: कतार में प्रतीक्षारत
- IN_PROGRESS: परिणाम जनरेट किया जा रहा है
- SUCCEEDED: अंतिम, परिणाम के साथ
- FAILED: अंतिम, कारण task_error में है
- CANCELED: अंतिम, बिना किसी परिणाम के
Name
progress
Type
integer
Description
काम पूरा होने का प्रतिशत, 0 से 100 तक। जब तक टास्क शुरू नहीं होता यह 0 रहता है और जब यह सफल होता है तो 100 हो जाता है।
Name
created_at
Type
timestamp
Description
वह समय जब टास्क बनाया गया था, यूनिक्स मिलीसेकंड में।
Name
started_at
Type
timestamp
Description
वह समय जब किसी वर्कर ने टास्क शुरू किया, यूनिक्स मिलीसेकंड में। तब तक null रहता है।
Name
finished_at
Type
timestamp
Description
वह समय जब टास्क अंतिम स्थिति तक पहुँचा, यूनिक्स मिलीसेकंड में। तब तक null रहता है।
Name
expires_at
Type
timestamp
Description
वह समय जब टास्क का परिणाम एक्सपायर होता है, यूनिक्स मिलीसेकंड में। यह finished_at के 3 दिन बाद होता है, या टास्क पूरा होने तक created_at के 3 दिन बाद। एंटरप्राइज़ अकाउंट्स के लिए, जो API परिणामों को अनिश्चित काल तक रखते हैं, यह लगभग 100 साल बाद होता है। एसेट रिटेंशन देखें।
Name
preceding_tasks
Type
integer
Description
जब टास्क PENDING है तब कतार में उसकी स्थिति। 1 का मतलब है कि यह अगला शुरू होगा। टास्क के कतार छोड़ने के बाद 0, और लिस्ट परिणामों में हमेशा 0।
Name
task_error
Type
object
Description
टास्क क्यों विफल हुआ। जब तक status, FAILED न हो, null। एरर देखें।
Name
consumed_credits
Type
integer
Description
किसी भी रिफंड के बाद, टास्क के लिए चार्ज किए गए क्रेडिट की संख्या। जो अनुरोध एरर लौटाता है उससे शुल्क नहीं लिया जाता। एक विफल टास्क 0 होता है, क्योंकि Meshy इसे रिफंड कर देता है। कैंसिल करने से टास्क तभी रिफंड होता है जब वह PENDING हो। यदि Meshy चार्ज को पढ़ नहीं पाता, तो get या stream रिस्पॉन्स में यह फ़ील्ड छोड़ दिया जाता है, और लिस्ट अनुरोध 500 लौटाता है। ऐसी स्थिति में, अनुरोध को फिर से करें।
Name
model_urls
Type
object
Description
मॉडल फ़ाइल के लिए डाउनलोड URL, आपके अनुरोध किए गए output.format के लिए एक एंट्री के साथ। टास्क सफल होने तक {}।
- Name
  glb
  Type
  string
  Description
  GLB फ़ाइल के लिए डाउनलोड URL। तब मौजूद होता है जब output.format, glb हो।
- Name
  obj
  Type
  string
  Description
  model.obj, model.mtl, और texture.png वाली एक zip फ़ाइल के लिए डाउनलोड URL। तब मौजूद होता है जब output.format, obj हो।
- Name
  bundle_zip
  Type
  string
  Description
  Meshy द्वारा जनरेट की गई हर फ़ाइल वाली एक zip फ़ाइल के लिए डाउनलोड URL। तब मौजूद होता है जब output.format, zip हो।