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

अपनी तस्वीरों को कस्टम फ्रिज मैग्नेट में बदलें — फ्रिज के लिए उपयुक्त आकार का, फ्लैट मैग्नेटिक बैक वाला एक गोल-आयताकार रंगीन डेप्थ रिलीफ — दो चरणों में: prototype आपकी इनपुट फ़ोटो से एक रंगीन कॉन्सेप्ट इमेज जनरेट करता है, फिर build उस कॉन्सेप्ट इमेज को एक रिलीफ 3D मॉडल में बदल देता है। दोनों चरण 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

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

सोर्स फोटो से एक सिंगल रंगीन (colorized) कॉन्सेप्ट इमेज जनरेट करें। मिलने वाली टास्क ID वही है जिसे आप बिल्ड एंडपॉइंट को input_task_id के रूप में पास करते हैं। रिस्पॉन्स शेप के लिए The Fridge Magnet Prototype Task Object देखें।

पैरामीटर

Name
image_url
Type
string
आवश्यक
Description
Meshy के लिए सोर्स फोटो जिसे फ्रिज-मैग्नेट-तैयार कॉन्सेप्ट इमेज में रंगीन (colorize) किया जाएगा। हम फिलहाल .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
डिस्प्ले उद्देश्यों के लिए वैकल्पिक टास्क नाम। अधिकतम 100 अक्षर।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
जब true सेट किया जाता है, तो प्रोटोटाइप इमेज बैकग्राउंड हटाकर पारदर्शी RGBA PNG के रूप में लौटाई जाती है, ताकि आप सब्जेक्ट को किसी भी बैकग्राउंड पर कंपोज़िट कर सकें।
यह केवल इस एंडपॉइंट द्वारा लौटाई गई इमेज को नियंत्रित करता है। यह उसी नाम वाले बिल्ड ऑप्शन (डिफ़ॉल्ट true) से अलग है, जो रिलीफिंग से पहले बैकग्राउंड हटाने को नियंत्रित करता है।

रिटर्न्स

रिस्पॉन्स की result प्रॉपर्टी में नए बनाए गए फ्रिज मैग्नेट प्रोटोटाइप टास्क की टास्क id होती है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें जब तक कि टास्क SUCCEEDED तक न पहुंच जाए, फिर उस ID को build endpoint को input_task_id के रूप में पास करें।

विफलता मोड (Failure Modes)

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 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

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

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

एक सफल प्रोटोटाइप टास्क से अंतिम 3D-प्रिंट करने योग्य फ्रिज मैग्नेट जनरेट करें। यह बिल्ड प्रोटोटाइप की रंगीन कॉन्सेप्ट इमेज पर एक डेप्थ-मैप रिलीफ पाइपलाइन चलाता है और आपके द्वारा मांगे गए फॉर्मैट में एक सिंगल मेश आर्टिफैक्ट भेजता है। रिस्पॉन्स के आकार के लिए The Fridge Magnet Build Task Object देखें।

पैरामीटर

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

`options`

रिलीफ ज्यामिति के लिए वैकल्पिक ट्यूनिंग पैरामीटर। हर फील्ड की एक उचित डिफ़ॉल्ट वैल्यू है — केवल उन्हें भेजें जिन्हें आप ओवरराइड करना चाहते हैं।

Name
badge_shape
Type
string
डिफ़ॉल्ट rounded-rect
Description
फ्रिज मैग्नेट की आउटलाइन सिल्हूट। उपलब्ध वैल्यूज़:
- circle
- rounded-rect (डिफ़ॉल्ट)
- hexagon
- shield
- star
Name
size_mm
Type
number
डिफ़ॉल्ट 60
Description
फ्रिज मैग्नेट की बाउंडिंग स्क्वायर एज लंबाई, मिलीमीटर में। रेंज: (0, 400].
Name
relief_height_mm
Type
number
डिफ़ॉल्ट 3.3
Description
बेस के ऊपर अधिकतम रिलीफ ऊँचाई, मिलीमीटर में। रेंज: [0, 20].
Name
relief_offset_mm
Type
number
डिफ़ॉल्ट 0
Description
एक्सट्रूज़न से पहले रिलीफ पर लागू किया गया वर्टिकल ऑफ़सेट, मिलीमीटर में। रेंज: [0, 20].
Name
base_thickness_mm
Type
number
डिफ़ॉल्ट 2.0
Description
रिलीफ के पीछे फ्लैट बेस प्लेट की मोटाई, मिलीमीटर में। फ्रिज-मैग्नेट की डिफ़ॉल्ट एक मोटा 2 mm बेस है — यह मैग्नेट को फ्रिज से चिपकने के लिए पर्याप्त बॉडी देता है ताकि रिलीफ नाज़ुक महसूस न हो। रेंज: [0, 20].
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
ट्रांसफ़र कर्व के लिए शेप पैरामीटर (केवल तभी मायने रखता है जब relief_curve, gamma हो)। रेंज: (0, 10].
Name
invert_depth
Type
boolean
डिफ़ॉल्ट false
Description
डेप्थ-मैप की व्याख्या को उलट दें ताकि गहरे क्षेत्र अधिक ऊँची रिलीफ बन जाएँ।
Name
smoothing
Type
number
डिफ़ॉल्ट 0.24
Description
रिलीफ निष्कर्षण से पहले डेप्थ मैप पर लागू की गई स्मूथिंग स्ट्रेंथ। रेंज: [0, 10].
Name
relief_scale
Type
number
डिफ़ॉल्ट 1.0
Description
relief_height_mm के ऊपर लागू किया गया वर्टिकल स्केल मल्टीप्लायर। रेंज: (0, 10].
Name
depth_threshold
Type
number
डिफ़ॉल्ट 0.1
Description
डेप्थ-मैप वैल्यूज़ के लिए लो-पास थ्रेशोल्ड; इससे कम कुछ भी शून्य पर क्लैंप कर दिया जाता है। रेंज: [0, 1].
Name
remove_background
Type
boolean
डिफ़ॉल्ट true
Description
रिलीफिंग से पहले प्रोटोटाइप की कॉन्सेप्ट इमेज की बैकग्राउंड को स्वचालित रूप से हटा दें।
यह उसी नाम के प्रोटोटाइप पैरामीटर (डिफ़ॉल्ट false) से अलग है, जो नियंत्रित करता है कि प्रोटोटाइप इमेज खुद पारदर्शिता के साथ लौटाई जाए या नहीं।
Name
export_resolution
Type
integer
डिफ़ॉल्ट 512
Description
एक्सपोर्ट के लिए उपयोग किया गया मेश रिज़ॉल्यूशन। रेंज: [64, 2048].

`output`

वैकल्पिक वायर-फ़ॉर्मैट चयनकर्ता। डिफ़ॉल्ट glb है।

Name
format
Type
string
डिफ़ॉल्ट glb
Description
बिल्ड द्वारा लौटाया गया आर्टिफैक्ट बंडल। उपलब्ध वैल्यूज़:
- glb (डिफ़ॉल्ट) — model_urls.glb के अंतर्गत एक सिंगल model.glb लौटाता है।
- obj — model.obj + model.mtl + texture.png को ज़िप करता है और बंडल को model_urls.obj के अंतर्गत लौटाता है।
- zip — जनरेटर द्वारा उत्पन्न हर आर्टिफैक्ट को ज़िप करता है और बंडल को model_urls.bundle_zip के अंतर्गत लौटाता है।

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

रिस्पॉन्स के result प्रॉपर्टी में नए बनाए गए फ्रिज मैग्नेट बिल्ड टास्क की टास्क id होती है। टास्क के SUCCEEDED तक पहुँचने तक Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें, फिर model_urls की एकमात्र एंट्री से आर्टिफैक्ट डाउनलोड करें।

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

Name
400 - Bad Request
Description
रिक्वेस्ट स्वीकार्य नहीं थी। सामान्य कारण:
- पैरामीटर गायब: input_task_id आवश्यक है।
- अमान्य UUID: input_task_id एक मान्य UUID नहीं है।
- पैरेंट सफल नहीं हुआ: संदर्भित प्रोटोटाइप टास्क अभी तक SUCCEEDED तक नहीं पहुँचा है।
- कोई कैंडिडेट नहीं: प्रोटोटाइप टास्क सफल हुआ लेकिन कोई कैंडिडेट इमेज नहीं बनी।
- विकल्प रेंज से बाहर: options फील्ड्स में से कोई एक अपनी अनुमत रेंज या enum सेट से बाहर था।
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/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

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

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

किसी वैध टास्क id के आधार पर प्रोटोटाइप या बिल्ड टास्क प्राप्त करें। URL पथ टास्क के स्टेज से मेल खाना चाहिए — यदि कोई बिल्ड टास्क /prototype/:id के माध्यम से प्राप्त किया जाता है तो 404 लौटता है, और इसका उल्टा भी सत्य है।

रिस्पॉन्स के आकार के लिए The Fridge Magnet Prototype Task Object और The Fridge Magnet Build Task Object देखें।

पैरामीटर

Name
id
Type
path
Description
प्राप्त किए जाने वाले फ्रिज मैग्नेट टास्क के लिए यूनिक पहचानकर्ता।

रिटर्न

रिस्पॉन्स में फ्रिज मैग्नेट टास्क ऑब्जेक्ट शामिल होता है। आकार इस बात पर निर्भर करता है कि कौन सा स्टेज अनुरोधित किया गया था।

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

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

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

एक फ्रिज मैग्नेट टास्क को कैंसल करें। यदि टास्क अभी भी 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 पथ से मेल नहीं खाता।

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).

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

एक फ्रिज मैग्नेट Task को स्ट्रीम करें

फ्रिज मैग्नेट task के लिए रीयल-टाइम अपडेट को Server-Sent Events (SSE) के ज़रिए स्ट्रीम करें। URL पथ को task के स्टेज से मेल खाना चाहिए — /prototype/:buildId/stream पर स्ट्रीम खोलने पर status_code: 404 के साथ एक सिंगल event: error पेलोड भेजा जाता है और स्ट्रीम बंद हो जाती है।

पैरामीटर

Name
id
Type
path
Description
स्ट्रीम करने के लिए फ्रिज मैग्नेट task का यूनीक आइडेंटिफायर।

रिटर्न

Server-Sent Events के रूप में Fridge Magnet Prototype या Fridge Magnet Build task objects की एक स्ट्रीम रिटर्न करता है। हर फ्रेम में उस स्टेज के लिए पूरा task object होता है — वही आकार जो Get एंडपॉइंट रिटर्न करता है — इसलिए जब तक task PENDING या IN_PROGRESS है, आउटपुट फ़ील्ड्स अभी बस भरी नहीं गई हैं (null, [] या {}) और finished_at null है।

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 PENDING frame below is abbreviated 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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

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

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

किसी एक चरण के लिए आपके फ्रिज मैग्नेट टास्क की पेजिनेटेड सूची प्राप्त करें। URL पथ चरण का चयन करता है — /prototype प्रोटोटाइप टास्क लौटाता है; /build बिल्ड टास्क लौटाता है। दूसरे चरण के टास्क किसी भी रिस्पॉन्स में शामिल नहीं होते।

Path पैरामीटर

Name
stage
Type
path
आवश्यक
Description
या तो prototype या build। कलेक्शन केवल उन्हीं टास्क को लौटाता है जिनका चरण URL से मेल खाता है — /prototype फ़ेच करने पर कभी भी बिल्ड टास्क नहीं मिलते और इसके विपरीत भी।

Query पैरामीटर

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: निर्माण समय के अनुसार अवरोही क्रम में सॉर्ट करें।

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

प्रति-चरण टास्क ऑब्जेक्ट की पेजिनेटेड सूची लौटाता है — /prototype सूचीबद्ध करते समय फ्रिज मैग्नेट प्रोटोटाइप टास्क ऑब्जेक्ट या /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=***"
    ]
  }
]

फ्रिज मैग्नेट प्रोटोटाइप टास्क ऑब्जेक्ट

फ्रिज मैग्नेट प्रोटोटाइप टास्क ऑब्जेक्ट एक वर्क यूनिट है जिसे Meshy एक सोर्स फोटो से रंगीन कॉन्सेप्ट इमेज जनरेट करने के लिए ट्रैक करता है। इस चरण का आउटपुट input_task_id के माध्यम से बिल्ड चरण में चेन किया जाता है।

Properties

Name
id
Type
string
Description
टास्क के लिए यूनिक आइडेंटिफ़ायर। हालाँकि हम इम्प्लीमेंटेशन डिटेल के रूप में टास्क आइडी के लिए एक k-sortable UUID का उपयोग करते हैं, आपको आइडी के फॉर्मैट के बारे में कोई अनुमान नहीं लगाना चाहिए।
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 स्टैंडर्ड का पालन करता है। उदाहरण के लिए, Friday, September 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
इस प्रोटोटाइप टास्क द्वारा जनरेट किए गए कॉन्सेप्ट इमेज कैंडिडेट के लिए डाउनलोड योग्य URL। वर्तमान में API हमेशा एक ही कैंडिडेट लौटाता है; यह फील्ड एक array है ताकि भविष्य के रिविजन में बिना किसी ब्रेकिंग बदलाव के कई कैंडिडेट सामने लाए जा सकें।

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=***"
  ]
}

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

फ्रिज मैग्नेट बिल्ड टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे 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.format, glb था (डिफ़ॉल्ट)।
- Name
  obj
  Type
  string
  Description
  एक zip बंडल के लिए डाउनलोड करने योग्य URL जिसमें model.obj, model.mtl, और texture.png होते हैं। यह तब मौजूद होता है जब output.format, obj था।
- Name
  bundle_zip
  Type
  string
  Description
  जनरेटर द्वारा उत्पन्न किए जाने वाले हर आर्टिफैक्ट के zip बंडल के लिए डाउनलोड करने योग्य URL। यह तब मौजूद होता है जब output.format, zip था।

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