टेक्स्ट से 3D API

टेक्स्ट से 3D API एक फीचर है जो आपको Meshy की टेक्स्ट से 3D क्षमताओं को अपने स्वयं के एप्लिकेशन में इंटीग्रेट करने की अनुमति देता है। इस सेक्शन में, आपको इस API के साथ शुरू करने के लिए आवश्यक सारी जानकारी मिलेगी।

टेक्स्ट से 3D दो-चरणों वाला वर्कफ़्लो इस्तेमाल करता है। पहले, बिना टेक्सचर के 3D मेश जनरेट करने के लिए एक प्रीव्यू टास्क (mode: "preview") बनाएँ, ताकि आप आकार का मूल्यांकन कर सकें। फिर, मेश पर टेक्सचर लागू करने के लिए पूर्ण हुए प्रीव्यू की टास्क ID को एक रिफाइन टास्क (mode: "refine") में पास करें। दोनों चरण समान एंडपॉइंट साझा करते हैं।

POST/openapi/v2/text-to-3d

टेक्स्ट से 3D प्रीव्यू टास्क बनाएँ

यह एंडपॉइंट टेक्स्ट से 3D प्रीव्यू टास्क बनाता है, जो टेक्स्ट prompt से बिना texture वाला 3D मेश (केवल ज्यामिति) जनरेट करता है। यह दो-चरणीय वर्कफ़्लो का पहला चरण है। प्रीव्यू सफल होने के बाद, texture करने के लिए refine टास्क बनाएँ में लौटाए गए टास्क ID का उपयोग करें। पूर्ण रिस्पॉन्स स्कीमा के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट देखें।

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
प्रीव्यू टास्क बनाते समय इस फ़ील्ड को "preview" पर सेट किया जाना चाहिए।
Name
prompt
Type
string
आवश्यक
Description
वर्णन करें कि 3D मॉडल किस तरह का ऑब्जेक्ट है। अधिकतम 600 अक्षर।
Name
model_type
Type
string
डिफ़ॉल्ट standard
Description
3D मेश जनरेशन का प्रकार निर्दिष्ट करें।
उपलब्ध मान:
- standard: नियमित उच्च-विवरण वाला 3D मेश जनरेशन।
- lowpoly: साफ़-सुथरे पॉलीगॉन के लिए ऑप्टिमाइज़ किया गया लो-पॉली मेश जनरेट करता है।
जब lowpoly चुना जाता है, तो ai_model, topology, target_polycount, should_remesh अनदेखे किए जाते हैं।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
उपयोग किए जाने वाले मॉडल का ID। उपलब्ध मान: meshy-5, meshy-6, latest (Meshy 6)।
Name
should_remesh
Type
boolean
डिफ़ॉल्ट false (meshy-6), true (others)
Description
नियंत्रित करता है कि रीमेश चरण सक्षम करना है या नहीं। false पर सेट होने पर, API सीधे सर्वोच्च-प्रिसिशन वाला त्रिकोणीय मेश लौटाएगा।

केवल तब लागू होता है जब should_remesh = true

Name
topology
Type
string
डिफ़ॉल्ट triangle
Description
जनरेट किए गए मॉडल की topology निर्दिष्ट करें।
उपलब्ध मान:
- quad: quad-dominant मेश जनरेट करें।
- triangle: decimated त्रिकोण मेश जनरेट करें।
Name
target_polycount
Type
integer
डिफ़ॉल्ट 30,000
Description
जनरेट किए गए मॉडल में पॉलीगॉन की लक्ष्य संख्या निर्दिष्ट करें। पॉलीगॉन की वास्तविक संख्या ज्यामिति की जटिलता के आधार पर लक्ष्य से अलग हो सकती है।
मान्य मान सीमा यूज़र टियर के आधार पर अलग-अलग होती है:
- 100 से 300,000 (समावेशी)
Name
decimation_mode
Type
integer
Description
पॉलीकाउंट स्तर सेट करके adaptive decimation सक्षम करें। सेट होने पर, target_polycount अनदेखा किया जाता है।
उपलब्ध मान:
- 1: Adaptive — अल्ट्रा पॉलीकाउंट।
- 2: Adaptive — उच्च पॉलीकाउंट।
- 3: Adaptive — मध्यम पॉलीकाउंट।
- 4: Adaptive — कम पॉलीकाउंट।

Name
symmetry_mode
Type
string
⚠ पुराना
डिफ़ॉल्ट auto
Description
डेप्रिकेटेड। यह पैरामीटर अब आउटपुट को प्रभावित नहीं करता।
symmetry_mode फ़ील्ड मॉडल जनरेशन प्रक्रिया के दौरान सममिति व्यवहार को नियंत्रित करता है।
मान्य मान हैं:
- off: सममिति अक्षम करता है।
- auto: इनपुट ज्यामिति के आधार पर सममिति को स्वचालित रूप से निर्धारित और लागू करता है।
- on: जनरेशन के दौरान सममिति लागू करता है।
Name
pose_mode
Type
string
डिफ़ॉल्ट ""
Description
जनरेट किए गए मॉडल के लिए pose mode निर्दिष्ट करें।
उपलब्ध मान:
- a-pose: मॉडल को A pose में जनरेट करें।
- t-pose: मॉडल को T pose में जनरेट करें।
- "" (खाली स्ट्रिंग): कोई विशिष्ट pose लागू नहीं किया गया।
Name
is_a_t_pose
Type
boolean
⚠ पुराना
डिफ़ॉल्ट false
Description
इसके बजाय pose_mode का उपयोग करें। मॉडल को A/T pose में जनरेट करना है या नहीं।
Name
art_style
Type
string
⚠ पुराना
डिफ़ॉल्ट realistic
Description
Meshy-6 द्वारा समर्थित नहीं। Meshy-6 का उपयोग करने वाले अनुरोध art_style को अनदेखा करेंगे, और कुछ संयोजन एरर का कारण बन सकते हैं। उपलब्ध मान: realistic, sculpture।
Sculpture style का उपयोग करते समय enable_pbr को false पर सेट किया जाना चाहिए, क्योंकि Sculpture style अपने स्वयं के PBR मैप का सेट जनरेट करता है।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
true पर सेट होने पर, इनपुट सामग्री को संभावित रूप से हानिकारक सामग्री के लिए स्वचालित रूप से स्क्रीन किया जाएगा। यदि हानिकारक सामग्री पाई जाती है, तो टास्क जनरेशन के लिए आगे नहीं बढ़ेगा।
prompt के टेक्स्ट को स्क्रीन किया जाएगा।
Name
target_formats
Type
string[]
Description
निर्दिष्ट करता है कि आउटपुट में कौन-से 3D फ़ाइल फ़ॉर्मैट शामिल करने हैं। केवल अनुरोधित फ़ॉर्मैट जनरेट और लौटाए जाएँगे, जिससे टास्क पूरा होने का समय कम हो सकता है। छोड़े जाने पर, सभी समर्थित फ़ॉर्मैट शामिल होते हैं।
उपलब्ध मान: glb, obj, fbx, stl, usdz, 3mf
छोड़े जाने पर, 3mf को छोड़कर सभी फ़ॉर्मैट जनरेट किए जाते हैं। 3mf केवल स्पष्ट रूप से निर्दिष्ट होने पर शामिल किया जाता है।
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
true पर सेट होने पर, टास्क अतिरिक्त रूप से प्रीव्यू का पारदर्शी-बैकग्राउंड (RGBA) संस्करण रेंडर करता है और GET रिस्पॉन्स पर इसे alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहता है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
true पर सेट होने पर, सेवा ऑब्जेक्ट की वास्तविक-विश्व ऊँचाई का स्वचालित रूप से अनुमान लगाने और मॉडल को उसी अनुसार रीसाइज़ करने के लिए AI vision का उपयोग करती है। जब तक origin_at स्पष्ट रूप से सेट न हो, ओरिजिन डिफ़ॉल्ट रूप से bottom होगा।

केवल तब लागू होता है जब auto_size = true

Name
origin_at
Type
string
डिफ़ॉल्ट bottom
Description
auto_size सक्षम होने पर ओरिजिन की स्थिति।
उपलब्ध मान: bottom, center.

रिटर्न

रिस्पॉन्स की result प्रॉपर्टी में नए बनाए गए टेक्स्ट से 3D टास्क का टास्क id होता है।

विफलता mode

Name
400 - Bad Request
Description
अनुरोध स्वीकार्य नहीं था। सामान्य कारण:
- अनुपस्थित पैरामीटर: कोई आवश्यक पैरामीटर (जैसे, prompt, mode) अनुपस्थित है।
- अमान्य पैरामीटर: art_style अनुमत मानों में से एक नहीं है।
- Prompt बहुत लंबा: prompt अक्षर सीमा से अधिक है।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।

Request

POST

/openapi/v2/text-to-3d

# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with remesh and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

POST/openapi/v2/text-to-3d

टेक्स्ट से 3D रिफाइन टास्क बनाएँ

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

पैरामीटर

Name
mode
Type
string
आवश्यक
Description
रिफाइन टास्क बनाते समय इस फ़ील्ड को "refine" पर सेट किया जाना चाहिए।
Name
preview_task_id
Type
string
आवश्यक
Description
संबंधित प्रीव्यू टास्क id।
दिए गए प्रीव्यू टास्क की स्थिति SUCCEEDED होनी चाहिए।
Name
enable_pbr
Type
boolean
डिफ़ॉल्ट false
Description
बेस कलर के अतिरिक्त PBR मैप (metallic, roughness, normal) जनरेट करें। जब ai_model meshy-6 या latest होता है, तो एक emission map भी शामिल किया जाता है।
Name
hd_texture
Type
boolean
डिफ़ॉल्ट false
Description
अधिक डिटेल के लिए बेस कलर टेक्सचर को 4K (4096×4096) रिज़ॉल्यूशन में जनरेट करें।
केवल तब समर्थित है जब ai_model meshy-6 या latest हो। PBR मैप हमेशा 2K में जनरेट किए जाते हैं।
Name
texture_prompt
Type
string
Description
टेक्सचरिंग प्रक्रिया का मार्गदर्शन करने के लिए अतिरिक्त टेक्स्ट prompt प्रदान करें। अधिकतम 600 वर्ण।
Name
texture_image_url
Type
string
Description
टेक्सचरिंग प्रक्रिया का मार्गदर्शन करने के लिए एक 2d इमेज प्रदान करें। हम वर्तमान में .jpg, .jpeg, और .png फ़ॉर्मैट का समर्थन करते हैं।
इमेज प्रदान करने के दो तरीके हैं:
- सार्वजनिक रूप से एक्सेस योग्य URL: ऐसा URL जो सार्वजनिक इंटरनेट से एक्सेस योग्य हो
- Data URI: इमेज का base64-encoded data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>
यदि मूल एसेट और अपलोड की गई इमेज के बीच पर्याप्त ज्यामिति अंतर हैं, तो इमेज टेक्सचरिंग इष्टतम रूप से काम नहीं कर सकती। टेक्सचरिंग प्रक्रिया का मार्गदर्शन करने के लिए texture_image_url या texture_prompt में से केवल एक का उपयोग किया जा सकता है। यदि दोनों पैरामीटर प्रदान किए जाते हैं, तो डिफ़ॉल्ट रूप से मॉडल को टेक्सचर करने के लिए texture_prompt का उपयोग किया जाएगा।
Name
ai_model
Type
string
डिफ़ॉल्ट latest
Description
रिफाइनिंग के लिए उपयोग किए जाने वाले मॉडल की ID। उपलब्ध मान: meshy-5, meshy-6, latest (Meshy 6)।
Name
moderation
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो इनपुट सामग्री को संभावित रूप से हानिकारक सामग्री के लिए स्वचालित रूप से स्क्रीन किया जाएगा। यदि हानिकारक सामग्री पाई जाती है, तो टास्क जनरेशन के लिए आगे नहीं बढ़ेगा।
texture_prompt से टेक्स्ट और texture_image_url से इमेज, दोनों को स्क्रीन किया जाएगा।
Name
remove_lighting
Type
boolean
डिफ़ॉल्ट true
Description
बेस कलर टेक्सचर से हाइलाइट्स और शैडो हटाता है, जिससे एक साफ़ परिणाम मिलता है जो कस्टम लाइटिंग सेटअप के तहत बेहतर काम करता है।
केवल तब समर्थित है जब ai_model meshy-6 या latest हो।
Name
target_formats
Type
string[]
Description
निर्दिष्ट करता है कि आउटपुट में कौन-से 3D फ़ाइल फ़ॉर्मैट शामिल करने हैं। केवल अनुरोधित फ़ॉर्मैट जनरेट और लौटाए जाएंगे, जिससे टास्क पूरा होने का समय कम हो सकता है। छोड़े जाने पर, सभी समर्थित फ़ॉर्मैट शामिल किए जाते हैं।
उपलब्ध मान: glb, obj, fbx, stl, usdz, 3mf
छोड़े जाने पर, 3mf को छोड़कर सभी फ़ॉर्मैट जनरेट किए जाते हैं। 3mf केवल स्पष्ट रूप से निर्दिष्ट किए जाने पर ही शामिल होता है।
Name
alpha_thumbnail
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो टास्क अतिरिक्त रूप से प्रीव्यू का transparent-background (RGBA) वर्शन रेंडर करता है और GET response पर इसे alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहती है।
Name
auto_size
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो सेवा AI vision का उपयोग करके ऑब्जेक्ट की वास्तविक-विश्व ऊँचाई का स्वचालित रूप से अनुमान लगाती है और उसी के अनुसार मॉडल को रीसाइज़ करती है। जब तक origin_at स्पष्ट रूप से सेट न किया गया हो, ओरिजिन डिफ़ॉल्ट रूप से bottom होगा।

केवल तब लागू होता है जब auto_size = true

Name
origin_at
Type
string
डिफ़ॉल्ट bottom
Description
auto_size सक्षम होने पर ओरिजिन की स्थिति।
उपलब्ध मान: bottom, center।

रिटर्न

response की result प्रॉपर्टी में नए बनाए गए टेक्स्ट से 3D टास्क की टास्क id होती है।

विफलता मोड

Name
400 - Bad Request
Description
अनुरोध स्वीकार्य नहीं था। सामान्य कारण:
- अमान्य टास्क ID: preview_task_id अमान्य है या मौजूद नहीं है।
- टास्क तैयार नहीं है: प्रीव्यू टास्क अभी तक सफल नहीं हुआ है।
- मॉडल मिसमैच: प्रीव्यू टास्क का AI मॉडल अनुरोधित रिफाइन मॉडल के साथ असंगत है।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
404 - Not Found
Description
preview_task_id द्वारा निर्दिष्ट प्रीव्यू टास्क नहीं मिला।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट पार कर ली है।

Request

POST

/openapi/v2/text-to-3d

# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

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

GET/openapi/v2/text-to-3d/:id

टेक्स्ट से 3D टास्क पुनर्प्राप्त करें

यह एंडपॉइंट आपको एक मान्य टास्क id दिए जाने पर टेक्स्ट से 3D टास्क पुनर्प्राप्त करने की अनुमति देता है। टेक्स्ट से 3D टास्क ऑब्जेक्ट में कौन-सी प्रॉपर्टीज़ शामिल हैं, यह देखने के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट देखें।

यह एंडपॉइंट preview और refine दोनों टास्क के लिए काम करता है।

पैरामीटर्स

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

रिटर्न्स

रिस्पॉन्स में टेक्स्ट से 3D टास्क ऑब्जेक्ट होता है। विवरण के लिए टेक्स्ट से 3D टास्क ऑब्जेक्ट सेक्शन देखें।

उदाहरण

mode	नमूना मॉडल
पूर्वावलोकन
रिफाइन

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

टेक्स्ट से 3D टास्क हटाएँ

यह एंडपॉइंट सभी संबंधित मॉडल और डेटा सहित टेक्स्ट से 3D टास्क को स्थायी रूप से हटा देता है। यह कार्रवाई अपरिवर्तनीय है।

पाथ पैरामीटर

Name
id
Type
path
Description
हटाए जाने वाले टेक्स्ट से 3D टास्क की ID।

रिटर्न

सफलता पर 200 OK लौटाता है।

Request

DELETE

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v2/text-to-3d

टेक्स्ट से 3D कार्यों की सूची

यह एंडपॉइंट आपको टेक्स्ट से 3D कार्यों की सूची प्राप्त करने की अनुमति देता है।

पैरामीटर

Name
page_num
Type
integer
डिफ़ॉल्ट 1
Description
पेजिनेशन के लिए पेज संख्या।
Name
page_size
Type
integer
डिफ़ॉल्ट 10
Description
पेज आकार सीमा। अधिकतम अनुमत 50 आइटम हैं।
Name
sort_by
Type
string
Description
सॉर्ट करने के लिए फ़ील्ड।
उपलब्ध मान:
- +created_at: निर्माण समय के अनुसार आरोही क्रम में सॉर्ट करें।
- -created_at: निर्माण समय के अनुसार अवरोही क्रम में सॉर्ट करें।

रिटर्न

टेक्स्ट से 3D कार्य ऑब्जेक्ट्स की पेजिनेटेड सूची लौटाता है।

Request

GET

/openapi/v2/text-to-3d

curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

टेक्स्ट से 3D टास्क को स्ट्रीम करें

यह एंडपॉइंट Server-Sent Events (SSE) का उपयोग करके टेक्स्ट से 3D टास्क के लिए रीयल-टाइम अपडेट स्ट्रीम करता है।

पैरामीटर

Name
id
Type
path
Description
स्ट्रीम करने के लिए टेक्स्ट से 3D टास्क का विशिष्ट पहचानकर्ता।

रिटर्न

Server-Sent Events के रूप में टेक्स्ट से 3D टास्क ऑब्जेक्ट्स की स्ट्रीम लौटाता है।

PENDING या IN_PROGRESS टास्क के लिए, प्रतिक्रिया स्ट्रीम में केवल आवश्यक progress और status फ़ील्ड शामिल होंगे।

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
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": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"texture_urls": [
  {
    "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
    "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
    "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
    "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
    "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
  }
],
"preceding_tasks": 0,
"task_error": {

  "message": ""

},

"consumed_credits": 20
}

टेक्स्ट से 3D टास्क ऑब्जेक्ट

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

ऑब्जेक्ट में निम्नलिखित गुण हैं:

प्रॉपर्टीज़

Name
id
Type
string
Description
कार्य के लिए अनन्य पहचानकर्ता। हालांकि हम task ids के लिए k-sortable UUID को कार्यान्वयन विवरण के रूप में उपयोग करते हैं, आपको id के प्रारूप के बारे में कोई भी अनुमान नहीं लगाना चाहिए।
Name
type
Type
string
Description
टेक्स्ट से 3D कार्य का प्रकार। संभावित मान preview चरण के कार्यों के लिए text-to-3d-preview और refine चरण के कार्यों के लिए text-to-3d-refine हैं।
Name
model_urls
Type
object
Description
Meshy द्वारा जनरेट की गई टेक्सचरयुक्त 3D मॉडल फ़ाइल का डाउनलोड करने योग्य URL। यदि कोई फ़ॉर्मैट जनरेट नहीं किया गया है, तो खाली स्ट्रिंग लौटाने के बजाय उस फ़ॉर्मैट की प्रॉपर्टी छोड़ दी जाएगी।
- Name
  glb
  Type
  string
  Description
  GLB फ़ाइल का डाउनलोड करने योग्य URL।
- Name
  fbx
  Type
  string
  Description
  FBX फ़ाइल का डाउनलोड करने योग्य URL।
- Name
  usdz
  Type
  string
  Description
  USDZ फ़ाइल का डाउनलोड करने योग्य URL।
- Name
  obj
  Type
  string
  Description
  OBJ फ़ाइल का डाउनलोड करने योग्य URL।
- Name
  mtl
  Type
  string
  Description
  MTL फ़ाइल का डाउनलोड करने योग्य URL।
- Name
  stl
  Type
  string
  Description
  STL फ़ाइल का डाउनलोड करने योग्य URL।
- Name
  3mf
  Type
  string
  Description
  3MF फ़ाइल का डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब target_formats के माध्यम से 3mf का अनुरोध किया गया हो।
Name
prompt
Type
string
Description
यह वही असंशोधित prompt है जिसका उपयोग कार्य बनाने के लिए किया गया था।
Name
negative_prompt
Type
string
⚠ पुराना
Description
पिछड़ी संगतता के लिए बनाए रखा गया। जनरेट किए गए मॉडलों पर इस फ़ील्ड का कोई कार्यात्मक प्रभाव नहीं है।
Name
art_style
Type
string
⚠ पुराना
Description
वह असंशोधित art_style जिसका उपयोग preview कार्य बनाने के लिए किया गया था। Meshy-6 द्वारा समर्थित नहीं है।
Name
texture_richness
Type
string
⚠ पुराना
Description
पिछड़ी संगतता के लिए बनाए रखा गया। जनरेट किए गए मॉडलों पर इस फ़ील्ड का कोई कार्यात्मक प्रभाव नहीं है।
Name
texture_prompt
Type
string
Description
refine चरण के दौरान टेक्सचरिंग प्रक्रिया को निर्देशित करने के लिए प्रदान किया गया अतिरिक्त टेक्स्ट prompt।
Name
texture_image_url
Type
string
Description
उस टेक्सचर इमेज का डाउनलोड करने योग्य URL जिसका उपयोग टेक्सचरिंग प्रक्रिया को निर्देशित करने के लिए किया गया था।
Name
thumbnail_url
Type
string
Description
मॉडल फ़ाइल की थंबनेल इमेज का डाउनलोड करने योग्य URL।
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url के पारदर्शी-बैकग्राउंड (RGBA) संस्करण का डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब कार्य alpha_thumbnail: true के साथ बनाया गया हो और पारदर्शी preview सफलतापूर्वक रेंडर हुआ हो; अन्यथा यह फ़ील्ड छोड़ दिया जाता है।
Name
video_url
Type
string
⚠ पुराना
Description
preview वीडियो का डाउनलोड करने योग्य URL। भविष्य के रिलीज़ में हटा दिया जाएगा।
Name
progress
Type
integer
Description
कार्य का progress। यदि कार्य अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी। जैसे ही कार्य सफल हो जाता है, यह 100 हो जाएगा।
Name
started_at
Type
timestamp
Description
कार्य शुरू होने का टाइमस्टैंप, मिलीसेकंड में। यदि कार्य अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
टाइमस्टैंप 1 जनवरी, 1970 UTC से बीते मिलीसेकंड की संख्या को दर्शाता है, और RFC 3339 मानक का पालन करता है। उदाहरण के लिए, शुक्रवार, 1 सितंबर, 2023 12:00:00 PM GMT को 1693569600000 के रूप में दर्शाया जाता है। यह Meshy API में सभी टाइमस्टैंप पर लागू होता है।
Name
created_at
Type
timestamp
Description
कार्य बनाए जाने का टाइमस्टैंप, मिलीसेकंड में।
Name
finished_at
Type
timestamp
Description
कार्य समाप्त होने का टाइमस्टैंप, मिलीसेकंड में। यदि कार्य अभी समाप्त नहीं हुआ है, तो यह प्रॉपर्टी 0 होगी।
Name
status
Type
string
Description
कार्य की स्थिति। संभावित मान PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक हैं।
Name
texture_urls
Type
array
Description
कार्य से जनरेट किए गए टेक्सचर URL ऑब्जेक्ट्स की एक array। सामान्यतः इसमें केवल एक टेक्सचर URL ऑब्जेक्ट होता है। प्रत्येक टेक्सचर URL में निम्नलिखित प्रॉपर्टीज़ होती हैं:
- Name
  base_color
  Type
  string
  Description
  बेस कलर मैप इमेज का डाउनलोड करने योग्य URL।
- Name
  metallic
  Type
  string
  Description
  metallic मैप इमेज का डाउनलोड करने योग्य URL।
  यदि कार्य enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ दी जाएगी।
- Name
  normal
  Type
  string
  Description
  नॉर्मल मैप इमेज का डाउनलोड करने योग्य URL।
  यदि कार्य enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ दी जाएगी।
- Name
  roughness
  Type
  string
  Description
  roughness मैप इमेज का डाउनलोड करने योग्य URL।
  यदि कार्य enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ दी जाएगी।
- Name
  emission
  Type
  string
  Description
  emission मैप इमेज का डाउनलोड करने योग्य URL।
  यदि कार्य enable_pbr: false के साथ बनाया गया है, या ai_model meshy-5 है, तो यह प्रॉपर्टी छोड़ दी जाएगी।
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 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "seed": 1234,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}