Creative Lab — चाबी का छल्ला API

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

POST /openapi/creative-lab/keychain/v1/prototype
POST /openapi/creative-lab/keychain/v1/build

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

Create a Keychain Prototype Task

सोर्स फोटो से एक सिंगल कलराइज़्ड कॉन्सेप्ट इमेज जनरेट करें। रिटर्न किया गया टास्क ID वही है जिसे आप build एंडपॉइंट को input_task_id के रूप में पास करते हैं। रिस्पॉन्स शेप के लिए The Keychain 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
name
Type
string
Description
डिस्प्ले प्रयोजनों के लिए वैकल्पिक टास्क नाम। अधिकतम 100 अक्षर।
यह आपके डैशबोर्ड और टास्क लिस्ट में टास्क को लेबल करता है। यह कीचेन पर नहीं उत्कीर्ण होता है — उसके लिए name_text का उपयोग करें।
Name
name_text
Type
string
Description
कीचेन पर उत्कीर्ण करने के लिए टेक्स्ट, जैसे किसी पालतू जानवर या व्यक्ति का नाम। अधिकतम 10 अक्षर, जिनकी गिनती बाइट्स के बजाय यूनिकोड अक्षरों के रूप में की जाती है, इसलिए 10-अक्षर का चीनी, जापानी, या कोरियाई नाम स्वीकार किया जाता है। बिना उत्कीर्णन के कीचेन बनाने के लिए इसे छोड़ दें।
टेक्स्ट का उपयोग करने से पहले आसपास का व्हाइटस्पेस ट्रिम किया जाता है और अदृश्य फॉर्मेटिंग कैरेक्टर हटा दिए जाते हैं। परिणामी वैल्यू prototype task object पर name_text के रूप में रिटर्न की जाती है, ताकि आप build स्टेज के लिए पैसे चुकाने से पहले यह पुष्टि कर सकें कि वास्तव में क्या उत्कीर्ण किया जाएगा।
उत्कीर्णन यहाँ, prototype स्टेज पर लागू किया जाता है। build stage इसे स्वतः इनहेरिट करता है और अपना अलग name_text स्वीकार नहीं करता।
जब टेक्स्ट प्लेन ASCII न हो, तो रिक्वेस्ट बॉडी को UTF-8 के रूप में भेजें और Content-Type: application/json; charset=utf-8 सेट करें। कुछ HTTP क्लाइंट्स — जिनमें Windows PowerShell का Invoke-RestMethod भी शामिल है — डिफ़ॉल्ट रूप से बॉडी को ISO-8859-1 के रूप में एन्कोड करते हैं, जो Meshy तक पहुंचने से पहले हर non-Latin कैरेक्टर को खामोशी से ? में बदल देता है। API इसे उस उत्कीर्णन से अलग नहीं कर सकता जिसे आपने वास्तव में मांगा था।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो prototype इमेज एक ट्रांसपेरेंट RGBA PNG के रूप में रिटर्न की जाती है जिसमें बैकग्राउंड हटा दिया गया होता है, ताकि आप सब्जेक्ट को किसी भी बैकग्राउंड पर कंपोज़िट कर सकें।
यह केवल इस एंडपॉइंट द्वारा रिटर्न की गई इमेज को नियंत्रित करता है। यह उसी नाम के build ऑप्शन (डिफ़ॉल्ट true) से अलग है, जो relief बनाने से पहले बैकग्राउंड हटाने को नियंत्रित करता है।

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

रिस्पॉन्स की result प्रॉपर्टी में नई बनाई गई keychain prototype टास्क का 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 स्ट्रिंग विकृत है।
- उत्कीर्णन बहुत लंबा है: name_text 10 अक्षरों से अधिक लंबा है। रिक्वेस्ट को छोटा करने के बजाय रिजेक्ट कर दिया जाता है, इसलिए आपसे कभी भी छोटा किया गया नाम उत्कीर्ण कीचेन के लिए चार्ज नहीं किया जाता।
- कंटेंट फ्लैग किया गया: इनपुट इमेज को NSFW या इंटेलेक्चुअल प्रॉपर्टी moderation द्वारा फ्लैग किया गया था, या name_text उत्कीर्णन को NSFW moderation द्वारा फ्लैग किया गया था। उत्कीर्णन की जांच केवल NSFW कंटेंट के लिए की जाती है — इंटेलेक्चुअल-प्रॉपर्टी स्क्रीनिंग इमेज पर लागू होती है।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल हुआ। कृपया अपनी API की जांचें।
Name
402 - Payment Required
Description
यह टास्क करने के लिए अपर्याप्त क्रेडिट।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।

Request

POST

/openapi/creative-lab/keychain/v1/prototype

# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "name_text": "Luna"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

Prototype example

Start with a source photo, then generate the prototype image used by the keychain build stage.

Source photo used as the Creative Lab Keychain input — Prototype input

Creative Lab Keychain prototype output generated from the source photo — Prototype output

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

Keychain बिल्ड टास्क बनाएं

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

पैरामीटर

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

`options`

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

Name
badge_shape
Type
string
डिफ़ॉल्ट circle
Description
keychain मेडलियन की आउटलाइन सिल्हूट। उपलब्ध मान:
- circle (डिफ़ॉल्ट)
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
डिफ़ॉल्ट 40
Description
keychain की बाउंडिंग स्क्वायर एज लंबाई, मिलीमीटर में। सीमा: (0, 400].
Name
relief_height_mm
Type
number
डिफ़ॉल्ट 2.2
Description
बेस से ऊपर अधिकतम रिलीफ ऊँचाई, मिलीमीटर में। सीमा: [0, 20].
Name
relief_offset_mm
Type
number
डिफ़ॉल्ट 0
Description
एक्सट्रूज़न से पहले रिलीफ पर लागू किया गया वर्टिकल ऑफ़सेट, मिलीमीटर में। सीमा: [0, 20].
Name
base_thickness_mm
Type
number
डिफ़ॉल्ट 0.1
Description
रिलीफ के पीछे फ्लैट बेस प्लेट की मोटाई, मिलीमीटर में। सीमा: [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 प्रॉपर्टी में नए बनाए गए keychain बिल्ड टास्क का टास्क id होता है। जब तक टास्क SUCCEEDED तक न पहुँच जाए, तब तक Get a Task एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें, फिर model_urls की सिंगल एंट्री से आर्टिफैक्ट डाउनलोड करें।

फेल्यर मोड

Name
400 - Bad Request
Description
रिक्वेस्ट स्वीकार्य नहीं थी। सामान्य कारण:
- पैरामीटर गायब: input_task_id आवश्यक है।
- अमान्य UUID: input_task_id एक मान्य UUID नहीं है।
- पेरेंट सफल नहीं हुआ: संदर्भित प्रोटोटाइप टास्क अभी तक SUCCEEDED तक नहीं पहुँचा है।
- कोई कैंडिडेट नहीं: प्रोटोटाइप टास्क सफल हुआ लेकिन उसने कोई कैंडिडेट इमेज नहीं बनाई।
- Options सीमा से बाहर: options की किसी फील्ड की वैल्यू उसकी अनुमत सीमा या enum सेट से बाहर थी।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए पर्याप्त क्रेडिट नहीं हैं।
Name
404 - Not Found
Description
संदर्भित प्रोटोटाइप टास्क मौजूद नहीं है, किसी अन्य यूज़र का है, या webapp के माध्यम से बनाया गया था (केवल API-mode प्रोटोटाइप टास्क ही बिल्ड में चेन होते हैं)।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।

Request

POST

/openapi/creative-lab/keychain/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/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": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Build example

The build task converts the selected prototype image into a 3D-printable keychain model.

Creative Lab Keychain build model preview — Build model preview

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

एक चाबी का छल्ला टास्क प्राप्त करें

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

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

पैरामीटर

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

रिटर्न मान

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

Request

GET

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

DELETE/openapi/creative-lab/keychain/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/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/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/keychain/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 के रूप में चाबी का छल्ला प्रोटोटाइप या चाबी का छल्ला बिल्ड टास्क ऑब्जेक्ट्स की एक स्ट्रीम लौटाता है। हर फ्रेम उस चरण के लिए पूरा टास्क ऑब्जेक्ट लेकर आता है — वही आकार जो Get एंडपॉइंट लौटाता है — इसलिए जब टास्क PENDING या IN_PROGRESS होता है, तो आउटपुट फ़ील्ड्स बस अभी तक भरे नहीं गए होते हैं (null, [] या {}) और finished_at, null होता है।

Request

GET

/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

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

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

GET/openapi/creative-lab/keychain/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
पेज साइज़ सीमा। अधिकतम अनुमत 100 आइटम हैं।
Name
sort_by
Type
string
डिफ़ॉल्ट -created_at
Description
छांटने के लिए फ़ील्ड। उपलब्ध मान:
- +created_at: निर्माण समय के अनुसार आरोही क्रम में छांटें।
- -created_at: निर्माण समय के अनुसार अवरोही क्रम में छांटें।

रिटर्न

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

Request

GET

/openapi/creative-lab/keychain/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-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": 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-keychain-prototype है।
Name
name
Type
string
Description
टास्क बनाते समय दिया गया टास्क नाम। यदि कोई नाम प्रदान नहीं किया गया था तो यह खाली स्ट्रिंग होगी।
Name
name_text
Type
string
Description
ट्रिमिंग और अदृश्य फॉर्मेटिंग वर्णों को हटाने के बाद, इस चाबी का छल्ला पर लागू की गई एनग्रेविंग। जब टास्क को name_text के बिना बनाया गया था तब यह अनुपस्थित होता है। यह पुष्टि करने के लिए कि आपके HTTP क्लाइंट की एन्कोडिंग में टेक्स्ट सुरक्षित रहा, इसकी तुलना उस चीज़ से करें जो आपने भेजी थी।
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 मानक का पालन करता है। उदाहरण के लिए, शुक्रवार, 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 हमेशा ठीक एक उम्मीदवार लौटाता है; यह फ़ील्ड एक ऐरे है ताकि भविष्य के संशोधन बिना किसी ब्रेकिंग परिवर्तन के कई उम्मीदवार प्रस्तुत कर सकें।

Example Keychain Prototype Task Object

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

चाबी का छल्ला बिल्ड टास्क ऑब्जेक्ट

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

Properties

Name
id
Type
string
Description
टास्क के लिए यूनीक आइडेंटिफायर।
Name
type
Type
string
Description
टास्क का टाइप। इसका मान creative-lab-keychain-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 Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}