Creative Lab — कोलैप्सिबल फिजेट API

किसी सोर्स फोटो को एक प्रिंट-इन-प्लेस कोलैप्सिबल फिजेट टॉय में बदलें: विषय की सिल्हूट नेस्टेड कॉन्सेंट्रिक रिंग्स के एक सेट में बदल जाती है जो सपाट होकर collapse हो जाती हैं और फिर से खिंच जाती हैं, बिना किसी असेंबली के एक ही टुकड़े में प्रिंट होती हैं।

POST /openapi/creative-lab/fidget-collapsible/v1

अन्य Creative Lab endpoints के विपरीत, इसमें कोई प्रोटोटाइप/बिल्ड स्टेज जोड़ी नहीं है — चुनने के लिए कोई इंटरमीडिएट उम्मीदवार नहीं होते, इसलिए एक ही टास्क इमेज को पूरी तरह 3D मॉडल तक ले जाता है। वेब ऐप जो ज्यामिति नियंत्रण उजागर करता है (साइज़, लेयर काउंट, गैप विड्थ, दीवार की मोटाई, एक्सट्रूज़न डेप्थ, बल्ज) वे भी अनुरोध का हिस्सा नहीं हैं: हर टास्क समान सर्वर-साइड डिफ़ॉल्ट्स के साथ बनता है।

POST/openapi/creative-lab/fidget-collapsible/v1

एक Collapsible Fidget Task बनाएँ

एक स्रोत फ़ोटो से collapsible fidget मॉडल जनरेट करें। रिस्पॉन्स के आकार के लिए The Collapsible Fidget Task Object देखें।

प्रत्येक टास्क की लागत 6 क्रेडिट है और इसके लिए पेड प्लान आवश्यक है।

पैरामीटर

Name
image_url
Type
string
आवश्यक
Description
Meshy द्वारा collapsible fidget में बदलने के लिए स्रोत फ़ोटो। हम फिलहाल .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 कैरेक्टर। यह केवल एक टास्क लेबल है; मॉडल पर कुछ भी उकेरा नहीं जाता है।

रिटर्न

रिस्पॉन्स के result प्रॉपर्टी में नए बनाए गए collapsible fidget टास्क का टास्क id शामिल होता है। Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें जब तक कि टास्क SUCCEEDED तक न पहुँच जाए, फिर model_urls.stl से प्रिंट करने योग्य STL डाउनलोड करें (और, जब मौजूद हो, तो पहले प्रीव्यू करने के लिए model_urls.glb से GLB डाउनलोड करें)।

विफलता के प्रकार

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
403 - Forbidden
Description
इनपुट इमेज को इंटेलेक्चुअल प्रॉपर्टी उल्लंघन के लिए फ़्लैग किया गया था।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।

Request

POST

/openapi/creative-lab/fidget-collapsible/v1

curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1 \
  -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": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/creative-lab/fidget-collapsible/v1/:id

एक कोलैप्सिबल फ़िजेट टास्क प्राप्त करें

किसी वैध टास्क id को देखते हुए एक कोलैप्सिबल फ़िजेट टास्क प्राप्त करें। केवल इस एंडपॉइंट के माध्यम से बनाए गए टास्क ही यहाँ एक्सेस किए जा सकते हैं — किसी अन्य Creative Lab एंडपॉइंट से आया टास्क, या वेब ऐप में बनाया गया टास्क, 404 लौटाता है।

प्रतिक्रिया के स्वरूप के लिए The Collapsible Fidget Task Object देखें।

पैरामीटर

Name
id
Type
path
Description
प्राप्त करने के लिए कोलैप्सिबल फ़िजेट टास्क का यूनीक आइडेंटिफ़ायर।

रिटर्न

प्रतिक्रिया में कोलैप्सिबल फ़िजेट टास्क ऑब्जेक्ट शामिल है।

Request

GET

/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}

DELETE/openapi/creative-lab/fidget-collapsible/v1/:id

एक कोलैप्सिबल फिजेट टास्क डिलीट करें

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

पाथ पैरामीटर्स

Name
id
Type
path
Description
कैंसल किए जाने वाले कोलैप्सिबल फिजेट टास्क के लिए यूनिक आइडेंटिफ़ायर।

रिटर्न

सफलता पर खाली बॉडी के साथ 204 No Content रिटर्न करता है।

फेलियर मोड्स

Name
400 - Bad Request
Description
टास्क पहले से ही एक टर्मिनल स्टेट में है और इसे कैंसल नहीं किया जा सकता।
Name
404 - Not Found
Description
टास्क मौजूद नहीं है, किसी अन्य यूज़र का है, या इसे इस एंडपॉइंट के माध्यम से नहीं बनाया गया था।

Request

DELETE

/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

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

GET/openapi/creative-lab/fidget-collapsible/v1/:id/stream

एक Collapsible Fidget Task को स्ट्रीम करें

Server-Sent Events (SSE) के माध्यम से एक collapsible fidget task के लिए रीयल-टाइम अपडेट स्ट्रीम करें। यदि कोई task मौजूद नहीं है, या इस एंडपॉइंट के माध्यम से नहीं बनाया गया था, तो यह status_code: 404 के साथ एक एकल event: error पेलोड emit करता है और स्ट्रीम को बंद कर देता है।

पैरामीटर

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

रिटर्न

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

Request

GET

/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (task not found, or not created through this endpoint)
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": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}

GET/openapi/creative-lab/fidget-collapsible/v1

कोलैप्सिबल फिजेट टास्क सूचीबद्ध करें

अपने कोलैप्सिबल फिजेट टास्क की एक पेजिनेटेड सूची प्राप्त करें। केवल इस एंडपॉइंट के माध्यम से बनाए गए टास्क ही शामिल किए जाते हैं।

क्वेरी पैरामीटर

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

रिटर्न

द कोलैप्सिबल फिजेट टास्क ऑब्जेक्ट की एक पेजिनेटेड सूची लौटाता है।

Request

GET

/openapi/creative-lab/fidget-collapsible/v1

curl https://api.meshy.ai/openapi/creative-lab/fidget-collapsible/v1?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-fidget-collapsible",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123512000,
    "expires_at": 1729382712000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
    }
  }
]

The Collapsible Fidget Task Object

The Collapsible Fidget Task ऑब्जेक्ट एक वर्क यूनिट है जिसे Meshy किसी सोर्स फोटो को प्रिंट-इन-प्लेस कोलैप्सिबल फिजेट मॉडल में बदलने के लिए ट्रैक करता है। यह एक सिंगल-स्टेज टास्क है: इससे चेन करने के लिए कोई प्रोटोटाइप नहीं है, और इंटरमीडिएट सिल्हूट रिस्पॉन्स का हिस्सा नहीं है।

Properties

Name
id
Type
string
Description
टास्क के लिए यूनीक आइडेंटिफायर। जबकि हम टास्क आईडी के लिए इम्प्लीमेंटेशन डिटेल के रूप में k-sortable UUID का उपयोग करते हैं, आपको id के फॉर्मेट के बारे में कोई धारणा नहीं बनानी चाहिए।
Name
type
Type
string
Description
टास्क का टाइप। वैल्यू creative-lab-fidget-collapsible है।
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
टास्क कब बनाया गया था, इसका टाइमस्टैंप, मिलीसेकंड में।
एक टाइमस्टैंप RFC 3339 स्टैंडर्ड के अनुसार, 1 जनवरी, 1970 UTC से बीते मिलीसेकंड की संख्या को दर्शाता है। उदाहरण के लिए, शुक्रवार, 1 सितंबर, 2023 12:00:00 PM GMT को 1693569600000 के रूप में दर्शाया जाता है। यह Meshy API में सभी टाइमस्टैंप पर लागू होता है।
Name
started_at
Type
timestamp
Description
टास्क कब शुरू किया गया था, इसका टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी null होगी।
Name
finished_at
Type
timestamp
Description
टास्क कब समाप्त हुआ था, इसका टाइमस्टैंप, मिलीसेकंड में। यदि टास्क अभी समाप्त नहीं हुआ है, तो यह प्रॉपर्टी null होगी।
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
इस टास्क द्वारा consumed_credits की संख्या। यह तब मौजूद होता है जब टास्क का स्टेटस PENDING, IN_PROGRESS, या SUCCEEDED हो। FAILED टास्क के लिए 0 रिटर्न करता है (फेलियर पर क्रेडिट रिफंड कर दिए जाते हैं)।
Name
model_urls
Type
object
Description
जनरेट किए गए 3D मॉडल के लिए डाउनलोड करने योग्य URL। टास्क SUCCEEDED हो जाने पर पॉप्युलेट होता है: stl हमेशा मौजूद रहता है, glb केवल तब जब प्रीव्यू रेंडर सफल हुआ हो।
- Name
  stl
  Type
  string
  Description
  STL फ़ाइल के लिए डाउनलोड करने योग्य URL। यह प्रिंट करने योग्य डिलिवरेबल है — इसे सीधे स्लाइसर पर भेजें।
- Name
  glb
  Type
  string
  Description
  मॉडल को 3D व्यूअर में प्रीव्यू करने के लिए, GLB फ़ाइल का डाउनलोड करने योग्य URL। इसके रंग केवल प्रीव्यू के लिए हैं: STL में कोई रंग नहीं होता है, और प्रिंट किए गए फिजेट को उसका रंग फिलामेंट से मिलता है। GLB बेस्ट-एफर्ट आधार पर है: जब प्रीव्यू रेंडर उपलब्ध नहीं होता है, तो model_urls से यह key पूरी तरह छोड़ दी जाती है, इसलिए इसे सावधानीपूर्वक पढ़ें — stl ही डिलिवरेबल है और SUCCEEDED टास्क पर हमेशा मौजूद रहता है।

Example Collapsible Fidget Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-fidget-collapsible",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123512000,
  "expires_at": 1729382712000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  }
}