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

अपनी तस्वीरों को कस्टम फ्रिज मैग्नेट में बदलें — एक गोल-आयताकार रंगीन गहराई राहत के साथ एक सपाट चुंबकीय पीठ, जो फ्रिज के लिए आकारित है — दो चरणों में: प्रोटोटाइप आपके इनपुट फोटो से एक रंगीन अवधारणा छवि उत्पन्न करता है, फिर निर्माण उस अवधारणा छवि को एक राहत 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

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

स्रोत फोटो से एक रंगीन अवधारणा छवि उत्पन्न करें। लौटाया गया टास्क आईडी वह है जिसे आप 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 के रूप में लौटाया जाता है जिसमें पृष्ठभूमि हटा दी जाती है, ताकि आप विषय को किसी भी पृष्ठभूमि पर संयोजित कर सकें।
यह केवल वह छवि नियंत्रित करता है जो यह एंडपॉइंट लौटाता है। यह उसी नाम के बिल्ड विकल्प से अलग है (डिफ़ॉल्ट true), जो राहत देने से पहले पृष्ठभूमि हटाने को नियंत्रित करता है।

रिटर्न्स

प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए फ्रिज मैग्नेट प्रोटोटाइप टास्क का टास्क id होता है। Get a Task एंडपॉइंट को पोल करें या stream की सदस्यता लें जब तक कि टास्क SUCCEEDED तक नहीं पहुंच जाता, फिर उस आईडी को 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 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"
}

प्रोटोटाइप उदाहरण

एक स्रोत फोटो से शुरू करें, फिर फ्रिज मैग्नेट बिल्ड चरण द्वारा उपयोग की गई प्रोटोटाइप छवि उत्पन्न करें।

Creative Lab फ्रिज मैग्नेट इनपुट के रूप में उपयोग की गई स्रोत लैंडस्केप फोटो — प्रोटोटाइप इनपुट

स्रोत फोटो से उत्पन्न Creative Lab फ्रिज मैग्नेट प्रोटोटाइप आउटपुट — प्रोटोटाइप आउटपुट

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

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

एक सफल प्रोटोटाइप टास्क से अंतिम 3D-प्रिंट करने योग्य फ्रिज मैग्नेट उत्पन्न करें। बिल्ड प्रोटोटाइप की रंगीन अवधारणा छवि पर एक गहराई-मानचित्र राहत पाइपलाइन चलाता है और आपके द्वारा मांगे गए प्रारूप में एकल मेश आर्टिफैक्ट भेजता है। प्रतिक्रिया आकार के लिए फ्रिज मैग्नेट बिल्ड टास्क ऑब्जेक्ट देखें।

पैरामीटर

Name
input_task_id
Type
string
आवश्यक
Description
इस ही OpenAPI एंडपॉइंट के माध्यम से बनाए गए एक प्रोटोटाइप टास्क का टास्क आईडी। प्रोटोटाइप को उसी 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 मिमी बेस है — फ्रिज को पकड़ने के लिए मैग्नेट को पर्याप्त शरीर देता है बिना राहत को नाजुक महसूस किए। रेंज: [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 होता है। Get a Task एंडपॉइंट को पोल करें या stream की सदस्यता लें जब तक कि टास्क SUCCEEDED तक नहीं पहुंच जाता, फिर model_urls में एकल प्रविष्टि से आर्टिफैक्ट डाउनलोड करें।

विफलता मोड

Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
- पैरामीटर गायब: input_task_id आवश्यक है।
- अमान्य UUID: input_task_id एक मान्य UUID नहीं है।
- पैरेंट सफल नहीं हुआ: संदर्भित प्रोटोटाइप टास्क ने अभी तक SUCCEEDED तक नहीं पहुंचा है।
- कोई उम्मीदवार नहीं: प्रोटोटाइप टास्क सफल हुआ लेकिन कोई उम्मीदवार छवि उत्पन्न नहीं की।
- विकल्प सीमा से बाहर: options फ़ील्ड में से एक अपने अनुमत रेंज या एनम सेट के बाहर गिर गया।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल हुआ। कृपया अपनी API की जांचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
404 - Not Found
Description
संदर्भित प्रोटोटाइप टास्क मौजूद नहीं है, किसी अन्य उपयोगकर्ता का है, या वेबऐप के माध्यम से बनाया गया था (केवल API-मोड प्रोटोटाइप टास्क बिल्ड में चेन होते हैं)।
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"
}

बिल्ड उदाहरण

बिल्ड टास्क चयनित प्रोटोटाइप छवि को 3D-प्रिंट करने योग्य फ्रिज मैग्नेट मॉडल में बदल देता है।

Creative Lab फ्रिज मैग्नेट बिल्ड मॉडल पूर्वावलोकन — बिल्ड मॉडल पूर्वावलोकन

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

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

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

प्रतिक्रिया संरचनाओं के लिए फ्रिज मैग्नेट प्रोटोटाइप कार्य ऑब्जेक्ट और फ्रिज मैग्नेट निर्माण कार्य ऑब्जेक्ट देखें।

पैरामीटर्स

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

रिटर्न्स

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

अनुरोध

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

प्रोटोटाइप प्रतिक्रिया

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

निर्माण प्रतिक्रिया

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

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

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

पैरामीटर्स

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

रिटर्न्स

फ्रिज मैग्नेट प्रोटोटाइप या फ्रिज मैग्नेट बिल्ड कार्य वस्तुओं की स्ट्रीम को सर्वर-सेंट इवेंट्स के रूप में लौटाता है। PENDING या IN_PROGRESS कार्यों के लिए, प्रतिक्रिया स्ट्रीम केवल आवश्यक progress और status फ़ील्ड्स को शामिल करेगी।

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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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 निर्माण कार्य लौटाता है। अन्य चरण के कार्य किसी भी प्रतिक्रिया में शामिल नहीं होते हैं।

पथ पैरामीटर

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

रिटर्न्स

प्रति-चरण कार्य वस्तु की पेजिनेशन की गई सूची लौटाता है — या तो फ्रिज मैग्नेट प्रोटोटाइप कार्य वस्तु जब /prototype सूचीबद्ध कर रहे हों या फ्रिज मैग्नेट निर्माण कार्य वस्तु जब /build सूचीबद्ध कर रहे हों।

अनुरोध

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

प्रतिक्रिया (प्रोटोटाइप कार्यों की सूची)

[
  {
    "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 के माध्यम से बिल्ड चरण में जोड़ा जाता है।

गुण

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
कार्य की प्रगति। यदि कार्य अभी तक शुरू नहीं हुआ है, तो यह गुण 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 हमेशा ठीक एक उम्मीदवार लौटाता है; यह फ़ील्ड एक सरणी है ताकि भविष्य के संशोधन बिना किसी ब्रेकिंग बदलाव के कई उम्मीदवारों को सतह पर ला सकें।

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
कार्य की प्रगति। यदि कार्य अभी तक शुरू नहीं हुआ है, तो यह गुण 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
  model.obj, model.mtl, और texture.png युक्त एक ज़िप बंडल के लिए डाउनलोड करने योग्य URL। जब output.format obj था तब उपस्थित।
- Name
  bundle_zip
  Type
  string
  Description
  जनरेटर द्वारा उत्पन्न प्रत्येक आर्टिफैक्ट के ज़िप बंडल के लिए डाउनलोड करने योग्य 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=***"
  }
}