Creative Lab फिगर API

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

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

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

Figure प्रोटोटाइप टास्क बनाएं

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

Request

POST

/openapi/creative-lab/figure/v1/prototype

# Stage 1: generate a chibi-style concept image
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

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

Prototype example

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

Source portrait used as the Creative Lab Figure input — Prototype input

Chibi-style figurine prototype image generated from the source photo — Prototype output

पैरामीटर

Name
image_url
Type
string
आवश्यक
Description
वह फोटो जिसे चिबी फिगर में बदलना है, एक पब्लिक URL या डेटा URI (data:image/jpeg;base64,<your base64-encoded image data>) के रूप में।
इमेज अधिकतम 20 MB की JPG, JPEG, PNG, या WebP फाइल होनी चाहिए।
Name
name
Type
string
Description
टास्क के लिए एक नाम, अधिकतम 100 कैरेक्टर तक। यह टास्क की name फील्ड में वापस आता है। एक लंबा नाम 400 रिटर्न करता है।
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
क्या प्रोटोटाइप इमेज से बैकग्राउंड हटाना है। true एक ट्रांसपेरेंट RGBA PNG रिटर्न करता है, ताकि आप सब्जेक्ट को किसी भी बैकग्राउंड पर रख सकें। बिल्ड भी इमेज को बिना बैकग्राउंड के साथ शुरू होता है। अगर Meshy बैकग्राउंड नहीं हटा पाता, तो यह इमेज को उसके बैकग्राउंड के साथ रिटर्न करता है, और टास्क फिर भी सफल होता है।

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

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

फेलियर मोड्स

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

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

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

एक सफल प्रोटोटाइप टास्क से टेक्सचर्ड 3D फिगर जनरेट करता है। इसके फील्ड्स के लिए, The Figure build task object देखें।

Request

POST

/openapi/creative-lab/figure/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

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

Build example

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

Creative Lab Figure build model preview — Build model preview

पैरामीटर

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

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

result फील्ड में नए बिल्ड टास्क की ID होती है। status के SUCCEEDED होने तक टास्क प्राप्त करें या इसे स्ट्रीम करें। फिर टेक्सचर्ड GLB को model_urls.glb से डाउनलोड करें। इसके बजाय OBJ के लिए, model_urls.obj को इसकी मटेरियल फ़ाइल model_urls.mtl के साथ डाउनलोड करें।

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

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

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

फिगर टास्क प्राप्त करें

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

फ़ील्ड्स के लिए, देखें फिगर prototype टास्क ऑब्जेक्ट और फिगर build टास्क ऑब्जेक्ट।

Request

GET

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

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-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-figure-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,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

पैरामीटर

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

रिटर्न

पाथ में दिए गए स्टेज के अनुसार prototype टास्क ऑब्जेक्ट या build टास्क ऑब्जेक्ट।

फेल्योर मोड्स

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

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

फिगर टास्क को डिलीट करें

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

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

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/figure/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/figure/v1/(prototype|build)/:id/stream

फिगर टास्क को स्ट्रीम करें

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

Request

GET

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

curl -N https://api.meshy.ai/openapi/creative-lab/figure/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-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

पैरामीटर

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

रिटर्न

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

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

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

फिगर टास्क की सूची

यह एक स्टेज के आपके फिगर टास्क एक बार में एक पेज के रूप में लौटाता है। पाथ स्टेज का चयन करता है। /prototype केवल prototype टास्क लौटाता है, और /build केवल build टास्क लौटाता है।

Request

GET

/openapi/creative-lab/figure/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-figure-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 टास्क ऑब्जेक्ट्स की एक array, जो पाथ में दी गई स्टेज से मेल खाती है।

फिगर prototype task ऑब्जेक्ट

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

Properties

Example Figure Prototype Task Object

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

फिगर बिल्ड टास्क ऑब्जेक्ट

एक बिल्ड टास्क एक सफल प्रोटोटाइप टास्क से एक टेक्सचर्ड 3D फिगर जनरेट करता है। इसके model_urls, thumbnail_url, और texture_urls फ़ील्ड्स का फॉर्मेट वही है जो इमेज से 3D टास्क ऑब्जेक्ट में है।

Properties

Example Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-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,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Name
id
Type
string
Description
टास्क ID। इसके फॉर्मेट पर निर्भर न करें।
Name
type
Type
string
Description
टास्क का प्रकार, हमेशा creative-lab-figure-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 रिस्पॉन्स में यह फ़ील्ड शामिल नहीं होती, और list रिक्वेस्ट 500 लौटाती है। ऐसी स्थिति में, रिक्वेस्ट को फिर से करें।
Name
prompt
Type
string
Description
Figure बिल्ड टास्क के लिए हमेशा ""।
Name
negative_prompt
Type
string
Description
prompt की तरह, Figure बिल्ड टास्क के लिए हमेशा ""।
Name
texture_prompt
Type
string
Description
prompt की तरह, Figure बिल्ड टास्क के लिए हमेशा ""।
Name
texture_image_url
Type
string
Description
prompt की तरह, Figure बिल्ड टास्क के लिए हमेशा ""।
Name
model_urls
Type
object
Description
3D मॉडल के लिए डाउनलोड URLs, एक टेक्सचर्ड GLB के रूप में और अपनी MTL फ़ाइल के साथ एक OBJ फ़ाइल के रूप में।
- Name
  glb
  Type
  string
  Description
  टेक्सचर्ड GLB फ़ाइल के लिए डाउनलोड URL।
- Name
  obj
  Type
  string
  Description
  ज्यामिति और UVs के साथ, OBJ फ़ाइल के लिए डाउनलोड URL।
- Name
  mtl
  Type
  string
  Description
  obj के साथ आने वाली MTL मटेरियल फ़ाइल के लिए डाउनलोड URL। इसे obj और texture_urls[0].base_color में दिए गए टेक्सचर के साथ उपयोग करें।
Name
thumbnail_url
Type
string
Description
मॉडल की प्रीव्यू इमेज के लिए डाउनलोड URL।
Name
texture_urls
Type
array
Description
टेक्सचर मैप्स, एक ऐसे ऐरे के रूप में जिसमें एक ऑब्जेक्ट होता है जो बेस कलर मैप रखता है।
- Name
  base_color
  Type
  string
  Description
  बेस कलर मैप के लिए डाउनलोड URL।
Name
remove_lighting
Type
boolean
Description
क्या Meshy ने बेस कलर टेक्सचर से हाइलाइट्स और शैडोज़ को हटाया।