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

किसी फ़ोटो को दो चरणों में एक रंगीन रिलीफ़ वाले 3D-प्रिंट करने योग्य चाबी के छल्ले में बदलें। एक प्रोटोटाइप टास्क फ़ोटो से एक रंगीन कॉन्सेप्ट इमेज जनरेट करता है। एक बिल्ड टास्क उस इमेज को एक रिलीफ़ 3D मॉडल में बदल देता है, और प्रोटोटाइप टास्क की ID को input_task_id के रूप में लेता है।

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

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

Keychain prototype टास्क बनाएँ

एक फ़ोटो से एक रंगीन कॉन्सेप्ट इमेज जनरेट करता है। 3D मॉडल बनाने के लिए, इस टास्क की ID को input_task_id के रूप में build एंडपॉइंट को पास करें। टास्क के फ़ील्ड्स के लिए, The Keychain prototype task object देखें।

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

पैरामीटर्स

Name
image_url
Type
string
आवश्यक
Description
वह फ़ोटो जिसे keychain कॉन्सेप्ट इमेज में बदलना है, एक पब्लिक URL या data URI (data:image/jpeg;base64,<your base64-encoded image data>) के रूप में।
इमेज अधिकतम 20 MB की JPG, JPEG, PNG, या WebP फ़ाइल होनी चाहिए।
Name
name
Type
string
Description
टास्क के लिए एक नाम, अधिकतम 100 अक्षर तक। यह टास्क के name फ़ील्ड में वापस आता है। इससे लंबा नाम 400 लौटाता है।
यह आपके डैशबोर्ड और टास्क लिस्ट में टास्क को लेबल करता है, और keychain पर दिखाई नहीं देता। keychain पर नाम डालने के लिए, name_text का उपयोग करें।
Name
name_text
Type
string
Description
keychain में जोड़ने के लिए एक नाम, जैसे किसी पालतू जानवर या व्यक्ति का नाम, अधिकतम 10 अक्षर तक। Meshy बाइट्स नहीं बल्कि अक्षर गिनता है, इसलिए 10-अक्षर का चीनी, जापानी, या कोरियाई नाम फिट हो जाता है। इससे लंबा नाम 400 लौटाता है। बिना नाम वाले keychain के लिए इसे छोड़ दें।
नाम keychain के चेहरे पर एक फ्लैट रंगीन डिटेल के रूप में दिखाई देता है, उभरे हुए या कटे हुए टेक्स्ट के रूप में नहीं।
Meshy आस-पास की व्हाइटस्पेस को ट्रिम करता है और अदृश्य फॉर्मेटिंग कैरेक्टर्स को हटा देता है। prototype task object परिणाम को name_text के रूप में लौटाता है, ताकि आप build के लिए भुगतान करने से पहले टेक्स्ट जांच सकें।
Meshy prototype चरण में नाम जोड़ता है। build इसे बनाए रखता है, और build एंडपॉइंट को भेजे गए name_text को नज़रअंदाज़ करता है।
जब टेक्स्ट प्लेन ASCII न हो, तो रिक्वेस्ट बॉडी को Content-Type: application/json; charset=utf-8 के साथ UTF-8 के रूप में भेजें। कुछ HTTP क्लाइंट्स, जैसे कि Windows PowerShell का Invoke-RestMethod, डिफ़ॉल्ट रूप से बॉडी को ISO-8859-1 के रूप में एनकोड करते हैं। इससे हर गैर-लैटिन कैरेक्टर रिक्वेस्ट के Meshy तक पहुँचने से पहले ? में बदल जाता है, और Meshy इसे आपके द्वारा भेजे गए नाम से अलग नहीं बता सकता।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
क्या prototype इमेज से बैकग्राउंड हटाना है। true एक पारदर्शी RGBA PNG लौटाता है जो पूरे मेडेलियन को बनाए रखता है, ताकि आप इसे किसी भी बैकग्राउंड पर रख सकें। build भी बिना बैकग्राउंड वाली इमेज से शुरू होता है। अगर Meshy बैकग्राउंड नहीं हटा सकता, तो यह इमेज को उसके बैकग्राउंड के साथ लौटाता है, और टास्क फिर भी सफल होता है।
build का remove_background विकल्प अलग है।

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

result फ़ील्ड नए prototype टास्क की ID रखता है। status के SUCCEEDED होने तक टास्क प्राप्त करें या इसे स्ट्रीम करें। फिर ID को input_task_id के रूप में build एंडपॉइंट को पास करें।

विफलता के मामले

Name
400 - Bad Request
Description
रिक्वेस्ट नहीं चल सकती। उदाहरण के लिए:
- image_url गायब है।
- इमेज JPG, JPEG, PNG, या WebP फ़ाइल नहीं है।
- इमेज बहुत छोटी है, 20 MB से अधिक है, या अधिकतम पिक्सेल संख्या से अधिक है।
- Meshy इमेज डाउनलोड नहीं कर सकता, उदाहरण के लिए क्योंकि URL 404 लौटाता है या टाइमआउट हो जाता है।
- data URI वैध base64 नहीं है।
- name_text 10 अक्षरों से लंबा है। Meshy इसे छोटा करने के बजाय अस्वीकार कर देता है, और रिक्वेस्ट के लिए शुल्क नहीं लेता।
- इमेज या name_text को NSFW के रूप में फ़्लैग किया गया था।
एरर मैसेज बताता है कि उसे कौन सी समस्या मिली। रिक्वेस्ट को ठीक करें, फिर इसे फिर से भेजें।
Name
401 - Unauthorized
Description
API की गायब है या अमान्य है। Authorization हेडर जांचें।
Name
402 - Payment Required
Description
इनमें से कोई एक लागू होता है:
- अकाउंट के पास पर्याप्त क्रेडिट नहीं हैं।
- API की, वर्कस्पेस, या सदस्य अपनी क्रेडिट सीमा तक पहुँच गया है।
- अकाउंट फ्री प्लान पर है।
अपने क्रेडिट और प्लान की जांच करें, फिर पुनः प्रयास करें।
Name
403 - Forbidden
Description
आपकी टीम ने IP Filtering चालू कर रखा है, और Meshy ने इमेज को थर्ड-पार्टी इंटेलेक्चुअल प्रॉपर्टी के लिए फ़्लैग किया है। ऐसी इमेज भेजें जिसे उपयोग करने का आपको अधिकार है। Meshy केवल इंटेलेक्चुअल प्रॉपर्टी के लिए इमेज की जांच करता है, name_text की नहीं।
Name
429 - Too Many Requests
Description
इनमें से एक सीमा पूरी हो गई थी:
- आपने अपनी रेट लिमिट द्वारा अनुमति से अधिक रिक्वेस्ट भेजे। कुछ सेकंड प्रतीक्षा करें, फिर पुनः प्रयास करें। Rate limits देखें।
- आपके बहुत अधिक टास्क कतार में हैं या चल रहे हैं। कुछ के पूरा होने की प्रतीक्षा करें, फिर पुनः प्रयास करें।
- बिना क्रेडिट बचे अनलिमिटेड प्लान पर, आप बिना क्रेडिट के चल सकने वाले टास्क की संख्या तक पहुँच गए हैं। किसी टास्क के पूरा होने की प्रतीक्षा करें, या क्रेडिट जोड़ें।
Name
500 - Internal Server Error
Description
Meshy को एक सर्वर एरर मिला, उदाहरण के लिए क्योंकि यह इमेज पर इंटेलेक्चुअल प्रॉपर्टी जांच नहीं चला सका। Meshy टास्क नहीं बनाता है, और उसने जो भी क्रेडिट चार्ज किए हैं उन्हें रिफंड करता है। रिक्वेस्ट को पुनः प्रयास करें।

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

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

सफल प्रोटोटाइप टास्क से 3D-प्रिंट करने योग्य keychain जनरेट करता है। Meshy प्रोटोटाइप की कॉन्सेप्ट इमेज को डेप्थ-मैप रिलीफ में बदलता है, और आपके चुने हुए फॉर्मेट में एक मॉडल फ़ाइल लौटाता है। टास्क के फ़ील्ड्स के लिए, देखें The Keychain build task object।

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

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

Creative Lab Keychain build model preview — Build model preview

पैरामीटर

Name
input_task_id
Type
string
आवश्यक
Description
बिल्ड करने के लिए प्रोटोटाइप टास्क की ID। यह आपके अकाउंट द्वारा POST /openapi/creative-lab/keychain/v1/prototype से बनाया गया टास्क होना चाहिए, जिसका स्टेटस SUCCEEDED हो।
अगर ID आपके API से बनाए गए Keychain प्रोटोटाइप टास्क में से कोई नहीं है, तो 404 लौटाता है, जिसमें वेब ऐप में बनाया गया प्रोटोटाइप भी शामिल है।
Name
name
Type
string
Description
टास्क के लिए एक नाम, अधिकतम 100 अक्षर। यह टास्क के name फ़ील्ड में वापस आता है। इससे लंबा नाम 400 लौटाता है।

`options`

रिलीफ के आकार के लिए वैकल्पिक सेटिंग्स। हर फ़ील्ड का एक डिफ़ॉल्ट मान है, इसलिए केवल वही भेजें जिसे आप बदलना चाहते हैं। किसी फ़ील्ड की सीमा से बाहर का मान 400 लौटाता है।

Name
badge_shape
Type
string
डिफ़ॉल्ट circle
Description
keychain की आउटलाइन जब Meshy इसे सब्जेक्ट से ट्रेस नहीं करता। Meshy इसका उपयोग तब करता है जब remove_background false हो, या जब इसे सब्जेक्ट की आउटलाइन न मिले।
उपलब्ध मान:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
डिफ़ॉल्ट 40
Description
keychain के बाउंडिंग स्क्वायर की किनारे की लंबाई, मिलीमीटर में, अधिकतम 400। 0 डिफ़ॉल्ट का उपयोग करता है।
Name
relief_height_mm
Type
number
डिफ़ॉल्ट 2.2
Description
बेस के ऊपर रिलीफ की अधिकतम ऊँचाई, मिलीमीटर में, 0 से 20 तक।
Name
relief_offset_mm
Type
number
डिफ़ॉल्ट 0
Description
रिलीफ को कितना नीचे करना है, मिलीमीटर में, 0 से 20 तक। Meshy इसे रिलीफ की ऊँचाई से हर जगह घटाता है, बेस तक।
Name
base_thickness_mm
Type
number
डिफ़ॉल्ट 0.1
Description
रिलीफ के पीछे फ्लैट बेस प्लेट की मोटाई, मिलीमीटर में, 0 से 20 तक।
Name
has_closed_back
Type
boolean
डिफ़ॉल्ट true
Description
क्या keychain की पीठ को बंद करना है। false पीठ को खुला छोड़ता है, एक शेल के रूप में।
Name
relief_curve
Type
string
डिफ़ॉल्ट linear
Description
वह कर्व जो डेप्थ-मैप मानों को रिलीफ ऊँचाई में मैप करता है।
उपलब्ध मान:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
डिफ़ॉल्ट 1.0
Description
कर्व की ताकत, अधिकतम 10। gamma और s-curve कर्व इसका उपयोग करते हैं, और linear इसे अनदेखा करता है। 0 डिफ़ॉल्ट का उपयोग करता है।
Name
invert_depth
Type
boolean
डिफ़ॉल्ट false
Description
क्या डेप्थ मैप को इन्वर्ट करना है, ताकि गहरे क्षेत्र अधिक रिलीफ बनें।
Name
smoothing
Type
number
डिफ़ॉल्ट 0.24
Description
Meshy द्वारा रिलीफ बनाने से पहले डेप्थ मैप को कितना स्मूद करना है, 0 से 10 तक।
Name
relief_scale
Type
number
डिफ़ॉल्ट 1.0
Description
आउटलाइन के भीतर, केंद्र के आसपास, रिलीफ और उसके टेक्सचर को कितना ज़ूम करना है, अधिकतम 10। 1 से अधिक मान सब्जेक्ट को बड़ा करता है, और 1 से कम मान इसे छोटा करता है। यह रिलीफ की ऊँचाई को नहीं बदलता। 0 डिफ़ॉल्ट का उपयोग करता है।
Name
depth_threshold
Type
number
डिफ़ॉल्ट 0.1
Description
वह डेप्थ-मैप मान जिसके नीचे Meshy डेप्थ को शून्य पर सेट करता है, 0 से 1 तक।
Name
remove_background
Type
boolean
डिफ़ॉल्ट true
Description
क्या keychain की आउटलाइन को सब्जेक्ट से ट्रेस करना है, ताकि keychain सब्जेक्ट के आकार का अनुसरण करे। false इसके बजाय badge_shape आउटलाइन का उपयोग करता है। Meshy badge_shape का उपयोग तब भी करता है जब उसे सब्जेक्ट की आउटलाइन न मिले।
यह प्रोटोटाइप के remove_background पैरामीटर से अलग है, जो सेट करता है कि प्रोटोटाइप इमेज में पारदर्शी बैकग्राउंड है या नहीं।
Name
export_resolution
Type
integer
डिफ़ॉल्ट 512
Description
एक्सपोर्ट किए गए मॉडल का मेश रिज़ॉल्यूशन, 64 से 512 तक। Meshy 512-पिक्सेल डेप्थ मैप से ज्यामिति बनाता है, इसलिए एक बारीक मेश विवरण जोड़े बिना फेस जोड़ देगा। 0 डिफ़ॉल्ट का उपयोग करता है।

`output`

वैकल्पिक। बिल्ड द्वारा लौटाए जाने वाले फ़ाइल फॉर्मेट को सेट करता है।

Name
format
Type
string
डिफ़ॉल्ट glb
Description
वह फ़ाइल फॉर्मेट जो बिल्ड लौटाता है।
उपलब्ध मान:
- glb: एक model.glb फ़ाइल, model_urls.glb में
- obj: model.obj, model.mtl, और texture.png वाली एक zip फ़ाइल, model_urls.obj में
- zip: Meshy द्वारा जनरेट की गई हर फ़ाइल वाली एक zip फ़ाइल, model_urls.bundle_zip में

रिटर्न

result फ़ील्ड में नए बिल्ड टास्क की ID होती है। टास्क प्राप्त करें या इसे स्ट्रीम करें जब तक status, SUCCEEDED न हो जाए। फिर model_urls में मौजूद एकमात्र एंट्री से फ़ाइल डाउनलोड करें।

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

Name
400 - Bad Request
Description
अनुरोध चल नहीं सकता। उदाहरण के लिए:
- input_task_id गायब है या मान्य टास्क ID नहीं है।
- प्रोटोटाइप टास्क का स्टेटस SUCCEEDED नहीं है। अगर यह अभी भी चल रहा है, तो प्रतीक्षा करें और पुनः प्रयास करें। अगर यह विफल हो गया या रद्द कर दिया गया, तो नया प्रोटोटाइप टास्क बनाएं।
- प्रोटोटाइप टास्क सफल रहा लेकिन उसमें कोई इमेज नहीं है। नया प्रोटोटाइप टास्क बनाएं।
- कोई options फ़ील्ड उसकी सीमा से बाहर है या उपलब्ध मान नहीं है।
एरर मैसेज बताता है कि कौन सी समस्या मिली।
Name
401 - Unauthorized
Description
API की गायब है या अमान्य है। Authorization हेडर जाँचें।
Name
402 - Payment Required
Description
इनमें से कोई एक लागू होता है:
- अकाउंट में पर्याप्त क्रेडिट नहीं हैं।
- API की, वर्कस्पेस, या सदस्य अपनी क्रेडिट सीमा तक पहुँच गया।
- अकाउंट फ्री प्लान पर है।
अपने क्रेडिट और प्लान की जाँच करें, फिर पुनः प्रयास करें।
Name
404 - Not Found
Description
input_task_id आपके अकाउंट द्वारा API से बनाए गए किसी भी Keychain प्रोटोटाइप टास्क से मेल नहीं खाता। वेब ऐप में बनाया गया प्रोटोटाइप भी 404 लौटाता है। प्रोटोटाइप create रिस्पॉन्स से result ID भेजें।
Name
429 - Too Many Requests
Description
इनमें से एक सीमा तक पहुँच गई थी:
- आपने अपनी रेट लिमिट से अधिक अनुरोध भेजे। कुछ सेकंड प्रतीक्षा करें, फिर पुनः प्रयास करें। देखें Rate limits।
- आपके बहुत से टास्क क़तार में हैं या चल रहे हैं। कुछ के पूरा होने की प्रतीक्षा करें, फिर पुनः प्रयास करें।
- बिना क्रेडिट के अनलिमिटेड प्लान पर, आप बिना क्रेडिट के चल सकने वाले टास्क की संख्या तक पहुँच गए। किसी टास्क के पूरा होने की प्रतीक्षा करें, या क्रेडिट जोड़ें।

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

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

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

फील्ड्स के लिए, देखें The Keychain prototype task object और The Keychain build task object।

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

पैरामीटर

Name
id
Type
path
Description
क्रिएट रिस्पॉन्स से टास्क ID।

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

prototype task object या build task object, जो पाथ में दिए गए स्टेज से मेल खाता हो।

विफलता के मामले

Name
400 - Bad Request
Description
id एक मान्य टास्क ID नहीं है। क्रिएट रिस्पॉन्स से result ID भेजें।
Name
403 - Forbidden
Description
आपकी टीम में IP Filtering चालू है, और Meshy ने प्रोटोटाइप टास्क की इमेज को थर्ड-पार्टी इंटेलेक्चुअल प्रॉपर्टी के रूप में फ्लैग किया है। बिल्ड टास्क और Enterprise प्लान पर मौजूद टीमों को यह एरर नहीं मिलता। ऐसी इमेज से प्रोटोटाइप टास्क बनाएं जिसका उपयोग करने का अधिकार आपके पास हो।
Name
404 - Not Found
Description
इस ID वाला कोई चाबी का छल्ला टास्क आपके अकाउंट से संबंधित नहीं है, या टास्क का स्टेज पाथ से मेल नहीं खाता। ID जांचें, और टास्क से मेल खाने के लिए /prototype या /build का उपयोग करें।
Name
500 - Internal Server Error
Description
Meshy इंटेलेक्चुअल प्रॉपर्टी जांच नहीं चला सका। रिक्वेस्ट फिर से भेजें।

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

चाबी का छल्ला टास्क हटाएं

यह एक चाबी का छल्ला टास्क को कैंसिल करता है। PENDING टास्क को कैंसिल करने पर उसके क्रेडिट वापस मिल जाते हैं। एक IN_PROGRESS टास्क बिना रिफंड के कैंसिल होता है, क्योंकि एक वर्कर पहले ही उस पर काम शुरू कर चुका होता है। अंतिम स्थिति (SUCCEEDED, FAILED, या CANCELED) वाले टास्क को कैंसिल नहीं किया जा सकता।

पाथ को टास्क के चरण से मेल खाना चाहिए। उदाहरण के लिए, बिल्ड टास्क की ID के साथ /prototype/:id पर DELETE करने से 404 रिटर्न होता है।

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

पाथ पैरामीटर

Name
id
Type
path
Description
कैंसिल किए जाने वाले टास्क की ID।

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

खाली बॉडी के साथ 204 No Content।

विफलता की स्थितियां

Name
400 - Bad Request
Description
इनमें से कोई एक लागू होता है:
- id एक मान्य टास्क ID नहीं है। क्रिएट रिस्पॉन्स से result ID भेजें।
- टास्क की पहले से ही अंतिम स्थिति है (SUCCEEDED, FAILED, या CANCELED), इसलिए इसे कैंसिल नहीं किया जा सकता।
Name
404 - Not Found
Description
इस ID वाला कोई चाबी का छल्ला टास्क आपके अकाउंट से संबंधित नहीं है, या टास्क का चरण पाथ से मेल नहीं खाता। ID जांचें, और टास्क से मेल खाने के लिए /prototype या /build का उपयोग करें।

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

एक Keychain टास्क को स्ट्रीम करें

किसी Keychain टास्क के अपडेट्स को Server-Sent Events (SSE) के रूप में स्ट्रीम करता है। पाथ टास्क के स्टेज से मेल खाना चाहिए। यदि यह मेल नहीं खाता, उदाहरण के लिए /prototype/:id/stream पर किसी build टास्क की ID, तो स्ट्रीम status_code: 404 के साथ एक error इवेंट भेजती है और बंद हो जाती है।

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 following PENDING frame is shortened 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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

पैरामीटर

Name
id
Type
path
Description
क्रिएट रिस्पॉन्स से मिली टास्क ID।

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

prototype या build टास्क ऑब्जेक्ट्स की एक स्ट्रीम। प्रत्येक इवेंट में पूरा टास्क ऑब्जेक्ट होता है, जैसा Get a Keychain task इसे रिटर्न करता है। जब तक टास्क PENDING या IN_PROGRESS स्थिति में है, इसके आउटपुट फ़ील्ड्स अभी भी खाली रहते हैं (null, [], या {}), और finished_at null रहता है।

यदि IP Filtering टास्क के रिज़ल्ट को ब्लॉक करती है, तो स्ट्रीम उसकी जगह एक error इवेंट भेजती है, जिसमें वही status_code होता है जो एक get रिक्वेस्ट रिटर्न करती।

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

Keychain टास्क की सूची बनाएं

एक समय में एक पेज, एक चरण के आपके चाबी का छल्ला टास्क लौटाता है। पाथ चरण का चयन करता है। /prototype केवल prototype टास्क लौटाता है, और /build केवल 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=***"
    ]
  }
]

पाथ पैरामीटर

Name
stage
Type
path
आवश्यक
Description
सूचीबद्ध करने का चरण, prototype या build।

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

Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
लौटाया जाने वाला पेज, 1 से 255 तक। 0 पहला पेज लौटाता है। 0 से 255 के बाहर का मान 400 लौटाता है।
Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
प्रति पेज टास्क की संख्या, 100 तक। 101 से 255 तक का मान 100 टास्क लौटाता है, और 0 डिफ़ॉल्ट का उपयोग करता है। 0 से 255 के बाहर का मान 400 लौटाता है।
Name
sort_by
Type
string
डिफ़ॉल्ट -created_at
Description
सॉर्ट ऑर्डर।
उपलब्ध मान:
- -created_at: सबसे नया पहले
- +created_at: सबसे पुराना पहले

रिटर्न

prototype टास्क ऑब्जेक्ट्स या build टास्क ऑब्जेक्ट्स का एक ऐरे, जो पाथ में दिए गए चरण से मेल खाता है।

Keychain prototype task ऑब्जेक्ट

एक prototype task एक फ़ोटो से एक रंगीन कॉन्सेप्ट इमेज जनरेट करता है। इमेज को 3D मॉडल में बदलने के लिए, टास्क की ID को build एंडपॉइंट में input_task_id के रूप में पास करें।

Properties

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

Name
id
Type
string
Description
टास्क ID। इसके फ़ॉर्मेट पर निर्भर न रहें।
Name
type
Type
string
Description
टास्क का प्रकार, हमेशा creative-lab-keychain-prototype।
Name
name
Type
string
Description
name जो आपने टास्क बनाते समय भेजा था, या "" यदि आपने कोई नहीं भेजा।
Name
name_text
Type
string
Description
वह नाम जो Meshy ने कीचेन में जोड़ा, व्हाइटस्पेस को ट्रिम करने और अदृश्य फॉर्मेटिंग कैरेक्टर हटाने के बाद। जब आपने name_text नहीं भेजा हो तो इसे छोड़ दिया जाता है। यह जांचने के लिए कि आपके HTTP क्लाइंट ने टेक्स्ट को सही तरीके से एन्कोड किया है, इसकी तुलना उससे करें जो आपने भेजा था।
Name
status
Type
string
Description
टास्क की स्थिति।
उपलब्ध मान:
- PENDING: कतार में प्रतीक्षारत
- IN_PROGRESS: परिणाम जनरेट हो रहा है
- SUCCEEDED: अंतिम, परिणाम के साथ
- FAILED: अंतिम, task_error में कारण के साथ
- CANCELED: अंतिम, बिना किसी परिणाम के
Name
progress
Type
integer
Description
काम पूरा होने का प्रतिशत, 0 से 100 तक। यह टास्क शुरू होने तक 0 रहता है और सफल होने पर 100 हो जाता है।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का समय, यूनिक्स मिलीसेकंड में।
Name
started_at
Type
timestamp
Description
वह समय जब किसी वर्कर ने टास्क शुरू किया, यूनिक्स मिलीसेकंड में। तब तक null।
Name
finished_at
Type
timestamp
Description
वह समय जब टास्क अंतिम स्थिति पर पहुंचा, यूनिक्स मिलीसेकंड में। तब तक null।
Name
expires_at
Type
timestamp
Description
वह समय जब टास्क का परिणाम समाप्त होता है, यूनिक्स मिलीसेकंड में। यह finished_at के 3 दिन बाद है, या टास्क पूरा होने तक created_at के 3 दिन बाद। Enterprise अकाउंट्स के लिए, जो API परिणामों को अनिश्चित काल तक बनाए रखते हैं, यह लगभग 100 साल बाद है। देखें एसेट रिटेंशन।
Name
preceding_tasks
Type
integer
Description
जब टास्क PENDING हो तब कतार में उसकी स्थिति। 1 का मतलब है कि यह अगला शुरू होगा। टास्क के कतार से बाहर निकलने के बाद 0, और सूची परिणामों में हमेशा 0।
Name
task_error
Type
object
Description
टास्क क्यों विफल हुआ। status के FAILED होने पर ही null नहीं होता। देखें एरर।
Name
consumed_credits
Type
integer
Description
किसी भी रिफंड के बाद, टास्क के लिए चार्ज किए गए क्रेडिट की संख्या। एरर लौटाने वाले अनुरोध से शुल्क नहीं लिया जाता। एक विफल टास्क 0 होता है, क्योंकि Meshy इसे रिफंड कर देता है। कैंसिल करने पर टास्क केवल PENDING होने के दौरान ही रिफंड होता है। यदि Meshy चार्ज को पढ़ नहीं पाता, तो get या stream रिस्पॉन्स में यह फ़ील्ड शामिल नहीं होती, और list अनुरोध 500 लौटाता है। ऐसी स्थिति में, अनुरोध को फिर से प्रयास करें।
Name
image_urls
Type
array of strings
Description
कॉन्सेप्ट इमेज के लिए डाउनलोड URL। टास्क सफल होने के बाद ऐरे में एक URL होता है, और तब तक यह खाली रहता है।

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

एक बिल्ड टास्क सफल प्रोटोटाइप टास्क से 3D चाबी का छल्ला जनरेट करता है। यह आपके द्वारा अनुरोध किए गए फॉर्मेट में एक मॉडल फ़ाइल लौटाता है।

प्रॉपर्टीज़

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

Name
id
Type
string
Description
टास्क ID। इसके फॉर्मेट पर भरोसा न करें।
Name
type
Type
string
Description
टास्क का प्रकार, हमेशा creative-lab-keychain-build।
Name
name
Type
string
Description
टास्क बनाते समय आपने जो name भेजा था, या यदि आपने कोई नहीं भेजा था तो ""।
Name
status
Type
string
Description
टास्क की स्थिति।
उपलब्ध मान:
- PENDING: कतार में प्रतीक्षा कर रहा है
- IN_PROGRESS: परिणाम जनरेट कर रहा है
- SUCCEEDED: अंतिम, परिणाम के साथ
- FAILED: अंतिम, task_error में कारण के साथ
- CANCELED: अंतिम, बिना किसी परिणाम के
Name
progress
Type
integer
Description
किए गए काम का प्रतिशत, 0 से 100 तक। जब तक टास्क शुरू नहीं होता तब तक यह 0 रहता है और जब यह सफल होता है तो 100 हो जाता है।
Name
created_at
Type
timestamp
Description
टास्क बनाए जाने का समय, यूनिक्स मिलीसेकंड में।
Name
started_at
Type
timestamp
Description
जब किसी वर्कर ने टास्क शुरू किया उसका समय, यूनिक्स मिलीसेकंड में। तब तक null रहता है।
Name
finished_at
Type
timestamp
Description
जब टास्क अंतिम स्थिति में पहुँचा उसका समय, यूनिक्स मिलीसेकंड में। तब तक null रहता है।
Name
expires_at
Type
timestamp
Description
जब टास्क का परिणाम एक्सपायर होता है उसका समय, यूनिक्स मिलीसेकंड में। यह finished_at के 3 दिन बाद होता है, या टास्क के खत्म होने तक created_at के 3 दिन बाद होता है। एंटरप्राइज़ खातों के लिए, जो API परिणामों को अनिश्चित काल तक रखते हैं, यह लगभग 100 साल बाद होता है। देखें एसेट रिटेंशन।
Name
preceding_tasks
Type
integer
Description
PENDING रहते हुए कतार में टास्क की स्थिति। 1 का मतलब है कि यह अगला शुरू होगा। टास्क के कतार छोड़ने के बाद 0, और लिस्ट परिणामों में हमेशा 0।
Name
task_error
Type
object
Description
टास्क क्यों विफल हुआ। जब तक status, FAILED न हो, तब तक null। देखें एरर।
Name
consumed_credits
Type
integer
Description
किसी भी रिफंड के बाद, टास्क के लिए चार्ज किए गए क्रेडिट की संख्या। जो अनुरोध एरर लौटाता है उससे शुल्क नहीं लिया जाता। विफल टास्क 0 है, क्योंकि Meshy इसे रिफंड कर देता है। कैंसिल करने पर टास्क का रिफंड केवल तभी मिलता है जब वह PENDING हो। यदि Meshy चार्ज नहीं पढ़ पाता, तो get या stream रिस्पॉन्स में यह फ़ील्ड शामिल नहीं होती, और लिस्ट अनुरोध 500 लौटाता है। ऐसी स्थिति में, अनुरोध को दोबारा प्रयास करें।
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 वाली एक zip फ़ाइल के लिए डाउनलोड URL। तब मौजूद होता है जब output.format, obj हो।
- Name
  bundle_zip
  Type
  string
  Description
  Meshy द्वारा जनरेट की गई हर फ़ाइल वाली एक zip फ़ाइल के लिए डाउनलोड URL। तब मौजूद होता है जब output.format, zip हो।