Creative Lab — लैंप API

एक स्रोत फ़ोटो को दो चरणों में 3D-प्रिंट करने योग्य लैंपशेड में बदलें: prototype एक स्टाइलाइज़्ड मैट-व्हाइट कॉन्सेप्ट इमेज जनरेट करता है और उसे एक खोखले 3D मॉडल (GLB) में बदल देता है, फिर build उस मॉडल पर लैंप प्रोसेसर चलाकर प्रिंट करने योग्य STL पार्ट्स तैयार करता है — लाइट-सोर्स फिक्स्चर के लिए एक बेस प्लेट वाला ओपन-बॉटम लैंपशेड, साथ ही फिक्स्चर माउंट खुद। दोनों चरण input_task_id के ज़रिए आपस में जुड़े होते हैं।

  • POST /openapi/creative-lab/lamp/v1/prototype
  • POST /openapi/creative-lab/lamp/v1/build

POST/openapi/creative-lab/lamp/v1/prototype

Create a Lamp Prototype Task

रेफरेंस फोटो से एक सिंगल मैट-व्हाइट कॉन्सेप्ट इमेज जनरेट करें और इसे एक होलो 3D लैंपशेड मॉडल में कन्वर्ट करें। रिस्पॉन्स में कॉन्सेप्ट इमेज (image_urls) और 3D मॉडल (model_urls.glb, जिसमें एक thumbnail_url होता है) दोनों शामिल होते हैं। रिटर्न किया गया टास्क ID वही है जिसे आप बिल्ड एंडपॉइंट को input_task_id के रूप में पास करते हैं। रिस्पॉन्स शेप के लिए The Lamp Prototype Task Object देखें।

पैरामीटर

  • Name
    image_url
    Type
    string
    आवश्यक
    Description

    सोर्स फोटो जिसे Meshy लैंपशेड के लिए विज़ुअल रेफरेंस के रूप में उपयोग करता है। हम वर्तमान में .jpg, .jpeg, .png, और .webp फॉर्मेट सपोर्ट करते हैं।

    इमेज प्रदान करने के दो तरीके हैं:

    • पब्लिकली एक्सेसिबल URL: एक URL जो पब्लिक इंटरनेट से एक्सेस किया जा सकता है।
    • Data URI: इमेज का एक base64-एनकोडेड data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    image_subject
    Type
    string
    डिफ़ॉल्ट character
    Description

    सब्जेक्ट कैटेगरी हिंट जो स्टाइलाइज़ेशन prompt को सेलेक्ट करता है। उपलब्ध वैल्यूज़:

    • character (डिफ़ॉल्ट) — सिंगल कैरेक्टर / ऑब्जेक्ट सब्जेक्ट (फिगरिन, एनिमल, मैस्कट, आदि)।
    • landscape — आउटडोर सीन / पैनोरामा सब्जेक्ट (माउंटेन, सिटीस्केप, फॉरेस्ट, आदि)।
  • Name
    name
    Type
    string
    Description

    डिस्प्ले पर्पस के लिए ऑप्शनल टास्क नाम। अधिकतम 100 अक्षर।

  • Name
    remove_background
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    जब true पर सेट किया जाता है, तो प्रोटोटाइप इमेज बैकग्राउंड हटाकर एक ट्रांसपेरेंट RGBA PNG के रूप में लौटाई जाती है, ताकि आप सब्जेक्ट को किसी भी बैकग्राउंड पर कंपोज़िट कर सकें।

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

रिस्पॉन्स की result प्रॉपर्टी में नए बनाए गए लैंप प्रोटोटाइप टास्क का टास्क id शामिल होता है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें, जब तक टास्क 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 स्ट्रिंग malformed है।
    • कंटेंट फ्लैग किया गया: इनपुट इमेज को NSFW या इंटेलेक्चुअल प्रॉपर्टी moderation द्वारा फ्लैग किया गया था।
    • अमान्य image_subject: character / landscape में से कोई एक नहीं है।
  • Name
    401 - Unauthorized
    Description

    प्रमाणीकरण विफल रहा। कृपया अपनी API की जांचें।

  • Name
    402 - Payment Required
    Description

    इस टास्क को करने के लिए अपर्याप्त क्रेडिट।

  • Name
    429 - Too Many Requests
    Description

    आपने अपनी रेट लिमिट पार कर ली है।

Request

POST
/openapi/creative-lab/lamp/v1/prototype
# Stage 1: concept image + hollow 3D lampshade model from a source photo
curl https://api.meshy.ai/openapi/creative-lab/lamp/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>",
    "image_subject": "character"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Prototype example
Start with a source photo; the prototype returns the concept image and a hollow 3D model that the build stage processes.
Source cat photo used as the Creative Lab Lamp input
Prototype input
Creative Lab Lamp prototype output generated from the source photo
Prototype output

POST/openapi/creative-lab/lamp/v1/build

एक Lamp Build Task बनाएं

एक सफल prototype task से अंतिम 3D-प्रिंट करने योग्य पार्ट्स जनरेट करें। build, prototype के 3D मॉडल पर lamp प्रोसेसर चलाता है: यह मॉडल को diameter_mm तक स्केल करता है, नीचे के हिस्से को cut_amount_percent से फ्लैट करता है, इसे thickness_mm तक खोखला बनाता है, नीचे को खोलता है, और — जब कोई fixture प्रीसेट चुना जाता है — तो fixture होल वाली एक बेस प्लेट और लाइट सोर्स के लिए एक अलग माउंट जोड़ता है। रिस्पॉन्स के फॉर्मेट के लिए The Lamp Build Task Object देखें।

पैरामीटर

  • Name
    input_task_id
    Type
    string
    आवश्यक
    Description

    इसी OpenAPI एंडपॉइंट के माध्यम से बनाए गए किसी prototype task की task ID। prototype को उसी API की के साथ बनाया गया होना चाहिए, उसे SUCCEEDED तक पहुँचना चाहिए, और उसने एक 3D मॉडल जनरेट किया होना चाहिए।

    webapp के माध्यम से बनाए गए prototype tasks स्वीकार नहीं किए जाते हैं — build एंडपॉइंट केवल उन्हीं prototype tasks को स्वीकार करता है जो POST /openapi/creative-lab/lamp/v1/prototype द्वारा बनाए गए हों, और किसी भी अन्य स्रोत को 404 के साथ अस्वीकार कर देता है।

  • Name
    name
    Type
    string
    Description

    डिस्प्ले प्रयोजनों के लिए वैकल्पिक task नाम। अधिकतम 100 अक्षर।

options

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

  • Name
    diameter_mm
    Type
    number
    डिफ़ॉल्ट 150
    Description

    मिलीमीटर में, lampshade बाउंडिंग बॉक्स का लक्षित अधिकतम आयाम। मेश को फ़िट होने के लिए यूनिफ़ॉर्मली स्केल किया जाता है। रेंज: [50, 400]

  • Name
    thickness_mm
    Type
    number
    डिफ़ॉल्ट 1
    Description

    मिलीमीटर में, खोखले lampshade की दीवार की मोटाई। रेंज: (0, 10]

  • Name
    cut_amount_percent
    Type
    number
    डिफ़ॉल्ट 1
    Description

    मॉडल की ऊँचाई का वह प्रतिशत जो नीचे से फ्लैट काटा जाता है, ताकि lampshade प्रिंट बेड पर टिक सके और fixture के लिए एक ओपनिंग हो। रेंज: [1, 100]

  • Name
    light_source_preset
    Type
    string
    डिफ़ॉल्ट bambu_mh001_60mm
    Description

    light-source fixture प्रीसेट जो यह तय करता है कि नीचे का हिस्सा कैसे बनाया जाए। उपलब्ध मान:

    • bambu_mh001_60mm (डिफ़ॉल्ट) — open-bottom lampshade के साथ एक बेस प्लेट जिसमें 60 mm का fixture होल है, दोनों model_urls.lamp_stl में, और fixture माउंट model_urls.base_stl के रूप में।
    • nonemodel_urls.lamp_stl में एक अकेला सील किया हुआ lampshade; model_urls.base_stl को छोड़ दिया जाता है।
  • Name
    fixture_offset_x_mm
    Type
    number
    डिफ़ॉल्ट 0
    Description

    मिलीमीटर में, बेस प्लेट पर fixture होल का X-अक्ष ऑफ़सेट, lampshade के केंद्र के सापेक्ष। केवल तब सार्थक है जब light_source_presetnone। रेंज: [-80, 80]

  • Name
    fixture_offset_z_mm
    Type
    number
    डिफ़ॉल्ट 0
    Description

    मिलीमीटर में, बेस प्लेट पर fixture होल का Z-अक्ष (गहराई) ऑफ़सेट, lampshade के केंद्र के सापेक्ष। केवल तब सार्थक है जब light_source_presetnone। रेंज: [-80, 80]

  • Name
    rotate_x_deg
    Type
    number
    डिफ़ॉल्ट 0
    Description

    प्रोसेसिंग से पहले मॉडल पर लागू, डिग्री में, X अक्ष के चारों ओर घुमाव। तीनों घुमाव मॉडल के केंद्र के चारों ओर XYZ यूलर कोणों के रूप में लागू किए जाते हैं। रेंज: [-360, 360]

  • Name
    rotate_y_deg
    Type
    number
    डिफ़ॉल्ट 0
    Description

    प्रोसेसिंग से पहले इंपोर्ट किए गए मेश पर लागू, डिग्री में, Y अक्ष के चारों ओर घुमाव। रेंज: [-360, 360]

  • Name
    rotate_z_deg
    Type
    number
    डिफ़ॉल्ट 0
    Description

    प्रोसेसिंग से पहले इंपोर्ट किए गए मेश पर लागू, डिग्री में, Z अक्ष के चारों ओर घुमाव। रेंज: [-360, 360]

  • Name
    include_result_json
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    जब true हो और output.format, zip हो, तो बंडल के अंदर lamp प्रोसेसर की result.json (पाइपलाइन का नाम, चेतावनियाँ, और आर्टिफ़ैक्ट पाथ्स) शामिल करता है। जब output.format, stl हो तो इसे अनदेखा किया जाता है।

output

वैकल्पिक वायर-फ़ॉर्मेट सेलेक्टर। डिफ़ॉल्ट stl है।

  • Name
    format
    Type
    string
    डिफ़ॉल्ट stl
    Description

    build द्वारा लौटाया गया आर्टिफ़ैक्ट बंडल। उपलब्ध मान:

    • stl (डिफ़ॉल्ट) — model_urls.lamp_stl (lampshade, साथ ही जब fixture प्रीसेट सेट हो तो बेस प्लेट सहित) लौटाता है, साथ ही जब light_source_presetnone हो तो model_urls.base_stl
    • zip — प्रोसेसर द्वारा जनरेट किए गए हर आर्टिफ़ैक्ट (lamp.stl, वैकल्पिक base.stl, वैकल्पिक result.json) को एक ही zip में पैकेज करता है और इसे model_urls.bundle_zip के अंतर्गत लौटाता है।

रिटर्न

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

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

  • Name
    400 - Bad Request
    Description

    अनुरोध स्वीकार्य नहीं था। सामान्य कारण:

    • पैरामीटर गायब है: input_task_id आवश्यक है।
    • अमान्य UUID: input_task_id एक मान्य UUID नहीं है।
    • Parent सफल नहीं हुआ: संदर्भित prototype task अभी तक SUCCEEDED तक नहीं पहुँचा है।
    • कोई मॉडल नहीं: prototype task सफल हुआ लेकिन उसने कोई 3D मॉडल जनरेट नहीं किया।
    • Options रेंज से बाहर: options की किसी फ़ील्ड की वैल्यू उसकी अनुमत रेंज या enum सेट से बाहर थी।
  • Name
    401 - Unauthorized
    Description

    प्रमाणीकरण विफल रहा। कृपया अपनी API की जांचें।

  • Name
    402 - Payment Required
    Description

    इस task को करने के लिए पर्याप्त क्रेडिट नहीं हैं।

  • Name
    404 - Not Found
    Description

    संदर्भित prototype task मौजूद नहीं है, किसी अन्य उपयोगकर्ता का है, या webapp के माध्यम से बनाया गया था (केवल API-mode prototype tasks ही build में चेन होते हैं)।

  • Name
    429 - Too Many Requests
    Description

    आपने अपनी रेट लिमिट पार कर ली है।

Request

POST
/openapi/creative-lab/lamp/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "diameter_mm": 120,
      "thickness_mm": 2,
      "light_source_preset": "bambu_mh001_60mm",
      "cut_amount_percent": 30
    },
    "output": {
      "format": "stl"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Build example
build task, prototype के 3D मॉडल को प्रिंट करने योग्य lampshade पार्ट्स में बदल देता है।
Creative Lab Lamp build model preview
Build model preview

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

लैंप टास्क प्राप्त करें

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

रिस्पॉन्स शेप के लिए The Lamp Prototype Task Object और The Lamp Build Task Object देखें।

पैरामीटर

  • Name
    id
    Type
    path
    Description

    प्राप्त करने के लिए लैंप टास्क का यूनीक आइडेंटिफ़ायर।

रिटर्न

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

Request

GET
/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

DELETE/openapi/creative-lab/lamp/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/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

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

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

लैंप टास्क को स्ट्रीम करें

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

पैरामीटर

  • Name
    id
    Type
    path
    Description

    स्ट्रीम करने के लिए लैंप टास्क का विशिष्ट पहचानकर्ता।

रिटर्न

Server-Sent Events के रूप में Lamp Prototype या Lamp Build टास्क ऑब्जेक्ट्स की एक स्ट्रीम लौटाता है। PENDING या IN_PROGRESS टास्क के लिए, रिस्पॉन्स स्ट्रीम में केवल आवश्यक progress और status फ़ील्ड शामिल होंगी।

Request

GET
/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

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

लैंप टास्क की सूची

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

Path Parameters

  • Name
    stage
    Type
    path
    आवश्यक
    Description

    या तो prototype या build। यह कलेक्शन केवल उन्हीं टास्क को लौटाता है जिनका स्टेज URL से मेल खाता है — /prototype लाने से कभी भी बिल्ड टास्क नहीं मिलते और इसका उल्टा भी सत्य है।

Query Parameters

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

Returns

प्रति-स्टेज टास्क ऑब्जेक्ट की एक पेजिनेटेड सूची लौटाता है — या तो द लैंप प्रोटोटाइप टास्क ऑब्जेक्ट जब /prototype की सूची बनाई जा रही हो, या द लैंप बिल्ड टास्क ऑब्जेक्ट जब /build की सूची बनाई जा रही हो।

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-lamp-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 30,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

The Lamp Prototype Task Object

Lamp Prototype Task ऑब्जेक्ट एक कार्य इकाई है जिसे Meshy ट्रैक करता है ताकि सोर्स फोटो से एक स्टाइलाइज़्ड मैट-व्हाइट कॉन्सेप्ट इमेज जनरेट की जा सके और उसे एक खोखले (hollow) 3D मॉडल में कन्वर्ट किया जा सके। इस स्टेज का आउटपुट input_task_id के माध्यम से बिल्ड स्टेज से जोड़ा (chained) जाता है।

Properties

  • Name
    id
    Type
    string
    Description

    टास्क के लिए यूनीक आइडेंटिफायर। हालांकि हम इंप्लीमेंटेशन डिटेल के रूप में टास्क id के लिए k-sortable UUID का उपयोग करते हैं, आपको id के फॉर्मेट के बारे में कोई धारणा नहीं बनानी चाहिए।

  • Name
    type
    Type
    string
    Description

    टास्क का प्रकार। इसका मान creative-lab-lamp-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

    टास्क बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।

  • Name
    started_at
    Type
    timestamp
    Description

    टास्क शुरू होने का टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।

  • Name
    finished_at
    Type
    timestamp
    Description

    टास्क समाप्त होने का टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी समाप्त नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।

  • Name
    expires_at
    Type
    timestamp
    Description

    टास्क का रिज़ल्ट expire होने का टाइमस्टैंप, मिलीसेकंड में।

  • Name
    preceding_tasks
    Type
    integer
    Description

    पूर्ववर्ती (preceding) टास्क की संख्या।

  • Name
    task_error
    Type
    object
    Description

    असफल टास्क के लिए एरर विवरण। पूर्ण task_error ऑब्जेक्ट रेफरेंस के लिए एरर देखें।

  • Name
    consumed_credits
    Type
    integer
    Description

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

  • Name
    model_urls
    Type
    object
    Description

    कॉन्सेप्ट इमेज से जनरेट किए गए 3D मॉडल के लिए डाउनलोड करने योग्य URLs। टास्क के सफल होने के बाद यह मौजूद होता है; उससे पहले {} होता है।

    • Name
      glb
      Type
      string
      Description

      GLB फॉर्मेट में खोखले (hollow) मैट-व्हाइट लैंपशेड मॉडल के लिए डाउनलोड करने योग्य URL। यह वह मॉडल है जिसे बिल्ड स्टेज प्रोसेस करता है।

  • Name
    thumbnail_url
    Type
    string
    Description

    3D मॉडल के एक रेंडर किए गए प्रीव्यू के लिए डाउनलोड करने योग्य URL। टास्क के सफल होने तक यह खाली स्ट्रिंग रहता है।

  • Name
    image_urls
    Type
    array of strings
    Description

    इस प्रोटोटाइप टास्क द्वारा जनरेट किए गए कॉन्सेप्ट इमेज कैंडिडेट्स के लिए डाउनलोड करने योग्य URLs। वर्तमान में API हमेशा ठीक एक ही कैंडिडेट लौटाता है; यह फील्ड एक array है ताकि भविष्य के रिविज़न बिना किसी ब्रेकिंग चेंज के कई कैंडिडेट्स दिखा सकें।

Example Lamp Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

लैंप बिल्ड टास्क ऑब्जेक्ट

लैंप बिल्ड टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे Meshy एक सफल प्रोटोटाइप टास्क से अंतिम 3D-प्रिंट करने योग्य लैंपशेड बनाने के लिए ट्रैक करता है। यह बिल्ड, प्रोटोटाइप के 3D मॉडल पर लैंप प्रोसेसर चलाकर उसे खोखला (hollow) करता है, नीचे के हिस्से को समतल करके खोलता है, और (फिक्सचर प्रीसेट के साथ) बेस प्लेट और फिक्सचर माउंट जोड़ता है।

Properties

  • Name
    id
    Type
    string
    Description

    टास्क के लिए यूनिक पहचानकर्ता।

  • Name
    type
    Type
    string
    Description

    टास्क का प्रकार। इसका मान creative-lab-lamp-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

    पूर्ववर्ती टास्क की संख्या। यह केवल तब सार्थक होती है जब status PENDING हो।

  • Name
    task_error
    Type
    object
    Description

    विफल टास्क के लिए एरर विवरण। पूर्ण task_error ऑब्जेक्ट संदर्भ के लिए एरर देखें।

  • Name
    consumed_credits
    Type
    integer
    Description

    इस टास्क द्वारा उपयोग किए गए क्रेडिट की संख्या। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।

  • Name
    model_urls
    Type
    object
    Description

    जनरेट किए गए आर्टिफैक्ट्स के लिए डाउनलोड करने योग्य URLs, जो आर्टिफैक्ट नाम के अनुसार कुंजीबद्ध (keyed) होते हैं। कुंजियों का सेट output.format और options.light_source_preset पर निर्भर करता है:

    • Name
      lamp_stl
      Type
      string
      Description

      lamp.stl का डाउनलोड करने योग्य URL: फिक्सचर होल वाली बेस प्लेट के साथ ओपन-बॉटम लैंपशेड, या जब options.light_source_preset none था तो एक सिंगल सील्ड लैंपशेड। यह तब मौजूद होता है जब output.format stl (डिफ़ॉल्ट) था।

    • Name
      base_stl
      Type
      string
      Description

      base.stl का डाउनलोड करने योग्य URL, लाइट-सोर्स फिक्सचर माउंट। यह तब मौजूद होता है जब output.format stl और options.light_source_preset none नहीं था। जब फिक्सचर प्रीसेट none था, तो इसे छोड़ दिया जाता है।

    • Name
      bundle_zip
      Type
      string
      Description

      प्रोसेसर द्वारा उत्पन्न हर आर्टिफैक्ट (lamp.stl, वैकल्पिक base.stl, और — जब options.include_result_json true हो — result.json) के zip बंडल का डाउनलोड करने योग्य URL। यह तब मौजूद होता है जब output.format zip था। जब bundle_zip मौजूद हो, तो lamp_stl / base_stl को छोड़ दिया जाता है।

Example Lamp Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}