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

चाबी का छल्ला प्रोटोटाइप कार्य बनाएँ

स्रोत फ़ोटो से एक एकल रंगीन कॉन्सेप्ट इमेज जनरेट करें। लौटाई गई task ID वही है जिसे आप build एंडपॉइंट में input_task_id के रूप में पास करते हैं। प्रतिक्रिया के आकार के लिए चाबी का छल्ला प्रोटोटाइप कार्य ऑब्जेक्ट देखें।

पैरामीटर

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 वर्ण।

रिटर्न

प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए चाबी का छल्ला प्रोटोटाइप कार्य की task id होती है। Get a Task एंडपॉइंट को poll करें या stream को subscribe करें जब तक कार्य 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 स्ट्रिंग विकृत है।
- चिह्नित सामग्री: इनपुट इमेज को NSFW या बौद्धिक संपदा moderation द्वारा चिह्नित किया गया।
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' \
  -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 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

चाबी का छल्ला बिल्ड टास्क बनाएँ

सफल प्रोटोटाइप टास्क से अंतिम 3D-प्रिंट योग्य चाबी का छल्ला पदक जनरेट करें। बिल्ड प्रोटोटाइप की रंगीन कॉन्सेप्ट इमेज पर डेप्थ-मैप रिलीफ़ पाइपलाइन चलाता है और आपके माँगे गए फ़ॉर्मैट में एकल मेश आर्टिफैक्ट भेजता है। प्रतिक्रिया संरचना के लिए चाबी का छल्ला बिल्ड टास्क ऑब्जेक्ट देखें।

पैरामीटर

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
चाबी का छल्ला पदक की बाहरी सिलुएट। उपलब्ध मान:
- circle (डिफ़ॉल्ट)
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
डिफ़ॉल्ट 40
Description
चाबी का छल्ला के बाउंडिंग वर्ग की भुजा की लंबाई, मिलीमीटर में। रेंज: (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
रिलीफ़िंग से पहले प्रोटोटाइप की कॉन्सेप्ट इमेज का बैकग्राउंड अपने-आप हटाएँ।
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 प्रॉपर्टी में नए बनाए गए चाबी का छल्ला बिल्ड टास्क का टास्क id होता है। टास्क प्राप्त करें एंडपॉइंट को पोल करें या stream को सब्सक्राइब करें जब तक टास्क SUCCEEDED तक न पहुँच जाए, फिर model_urls में मौजूद एकल एंट्री से आर्टिफैक्ट डाउनलोड करें।

विफलता mode

Name
400 - Bad Request
Description
अनुरोध स्वीकार्य नहीं था। सामान्य कारण:
- गुम पैरामीटर: input_task_id आवश्यक है।
- अमान्य UUID: input_task_id मान्य UUID नहीं है।
- पैरेंट सफल नहीं हुआ: संदर्भित प्रोटोटाइप टास्क अभी तक SUCCEEDED तक नहीं पहुँचा है।
- कोई उम्मीदवार नहीं: प्रोटोटाइप टास्क सफल हुआ लेकिन कोई उम्मीदवार इमेज उत्पन्न नहीं हुई।
- विकल्प रेंज से बाहर: 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"
}

बिल्ड उदाहरण

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

Creative Lab चाबी का छल्ला बिल्ड मॉडल पूर्वावलोकन — बिल्ड मॉडल पूर्वावलोकन

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

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

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

response संरचनाओं के लिए The Keychain Prototype Task Object और The Keychain Build Task Object देखें।

पैरामीटर

Name
id
Type
path
Description
पुनः प्राप्त किए जाने वाले चाबी का छल्ला टास्क का अद्वितीय पहचानकर्ता।

रिटर्न

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

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 पाथ टास्क के चरण से मेल खाना चाहिए — DELETE को /prototype/:buildId पर करने से 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 के रूप में चाबी का छल्ला प्रोटोटाइप या चाबी का छल्ला बिल्ड कार्य ऑब्जेक्ट्स की स्ट्रीम लौटाता है। PENDING या IN_PROGRESS कार्यों के लिए, रिस्पॉन्स स्ट्रीम में केवल आवश्यक progress और status फ़ील्ड शामिल होंगे।

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.
// 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-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
पृष्ठ आकार सीमा। अधिकतम अनुमत 50 आइटम हैं।
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 के माध्यम से बिल्ड चरण में जोड़ा जाता है।

प्रॉपर्टीज़

Name
id
Type
string
Description
कार्य के लिए अद्वितीय पहचानकर्ता। हालांकि हम implementation detail के रूप में task ids के लिए k-sortable UUID का उपयोग करते हैं, आपको id के फ़ॉर्मैट के बारे में कोई भी धारणा नहीं बनानी चाहिए।
Name
type
Type
string
Description
कार्य का प्रकार। मान creative-lab-keychain-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
कार्य बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।
टाइमस्टैंप 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
इस प्रोटोटाइप कार्य द्वारा जेनरेट किए गए कॉन्सेप्ट इमेज उम्मीदवारों के लिए डाउनलोड योग्य URLs। वर्तमान में API हमेशा ठीक एक उम्मीदवार लौटाता है; फ़ील्ड एक array है ताकि भविष्य के संशोधन breaking change के बिना कई उम्मीदवार दिखा सकें।

Example Keychain Prototype Task Object

{
  "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 ट्रैक रखता है ताकि SUCCEEDED प्रोटोटाइप टास्क से अंतिम 3D चाबी का छल्ला मेश जनरेट किया जा सके। यह बिल्ड प्रोटोटाइप की कॉन्सेप्ट इमेज पर डेप्थ-मैप रिलीफ पाइपलाइन चलाता है और कॉलर द्वारा अनुरोधित फ़ॉर्मैट में एकल मेश आर्टिफैक्ट प्रकाशित करता है।

प्रॉपर्टीज

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
  model.obj, model.mtl, और texture.png वाले zip बंडल के लिए डाउनलोड करने योग्य URL। तब मौजूद होता है जब 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=***"
  }
}