इमेज से 3D API

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

POST/openapi/v1/image-to-3d

Create an Image to 3D Task

यह एंडपॉइंट आपको एक नया इमेज से 3D टास्क बनाने देता है। यह देखने के लिए The Image to 3D Task Object देखें कि इमेज से 3D टास्क ऑब्जेक्ट के साथ कौन-सी प्रॉपर्टीज़ शामिल होती हैं।

पैरामीटर

input_task_id या image_url में से केवल एक आवश्यक है। यदि दोनों दिए गए हैं, तो input_task_id को प्राथमिकता मिलती है।

  • Name
    input_task_id
    Type
    string
    आवश्यक
    Description

    एक पूर्ण हो चुके इमेज-जनरेशन टास्क की ID, जिसके आउटपुट को इनपुट इमेज के रूप में उपयोग किया जाना चाहिए। यह टास्क निम्न में से कोई एक होना चाहिए: टेक्स्ट से इमेज या इमेज से इमेज। इसके अलावा, इसे API के माध्यम से चलाया गया होना चाहिए, इसका स्टेटस SUCCEEDED होना चाहिए, और इसे ठीक एक इमेज उत्पन्न करनी चाहिए।

  • Name
    image_url
    Type
    string
    आवश्यक
    Description

    मॉडल निर्माण में उपयोग के लिए Meshy को एक इमेज दें। हम वर्तमान में .jpg, .jpeg, और .png फ़ॉर्मैट का समर्थन करते हैं।

    इमेज देने के दो तरीके हैं:

    • सार्वजनिक रूप से पहुँच योग्य URL: ऐसा URL जो सार्वजनिक इंटरनेट से पहुँच योग्य हो।
    • Data URI: इमेज का base64-एन्कोडेड data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    model_type
    Type
    string
    डिफ़ॉल्ट standard
    Description

    3D मेश जनरेशन का प्रकार निर्दिष्ट करें।

    उपलब्ध मान:

    • standard: नियमित हाई-डिटेल 3D मेश जनरेशन।
    • lowpoly: साफ़ पॉलीगॉन के लिए अनुकूलित लो-पॉली मेश जनरेट करता है।

    जब lowpoly चुना जाता है, तो ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model अनदेखे किए जाते हैं।

  • Name
    ai_model
    Type
    string
    डिफ़ॉल्ट latest
    Description

    उपयोग किए जाने वाले मॉडल की ID। उपलब्ध मान: meshy-5, meshy-6, latest (Meshy 6)।

  • Name
    should_texture
    Type
    boolean
    डिफ़ॉल्ट true
    Description

    निर्धारित करता है कि टेक्सचर जनरेट किए जाएँ या नहीं। इसे false पर सेट करने से टेक्सचर चरण छोड़ दिया जाता है, जिससे बिना टेक्सचर वाला मेश मिलता है।

केवल तब लागू होता है जब should_texture = true
  • 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-एन्कोडेड data URI। data URI का उदाहरण: data:image/jpeg;base64,<your base64-encoded image data>

    यदि मूल 3D एसेट और अपलोड की गई इमेज के बीच पर्याप्त ज्यामिति अंतर हैं, तो इमेज टेक्सचरिंग बेहतर तरीके से काम नहीं कर सकती। टेक्सचरिंग प्रक्रिया का मार्गदर्शन करने के लिए texture_image_url या texture_prompt में से केवल एक का उपयोग किया जा सकता है। यदि दोनों पैरामीटर दिए गए हैं, तो डिफ़ॉल्ट रूप से मॉडल को टेक्सचर करने के लिए texture_prompt का उपयोग किया जाएगा। टेक्स्ट या इमेज में से किसी के भी माध्यम से टेक्सचरिंग पर प्रति टास्क 10 क्रेडिट खर्च होंगे।

  • 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
    save_pre_remeshed_model
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    true पर सेट होने पर, Meshy रीमेश चरण पूरा होने से पहले एक अतिरिक्त GLB फ़ाइल भी संग्रहीत करता है।

  • 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
    image_enhancement
    Type
    boolean
    डिफ़ॉल्ट true
    Description

    बेहतर परिणामों के लिए इनपुट इमेज को अनुकूलित करता है। किसी भी स्टाइल प्रोसेसिंग के बिना इनपुट इमेज का सटीक अपीयरेंस बनाए रखने के लिए false पर सेट करें।

    केवल तब समर्थित जब ai_model meshy-6 या latest हो।

  • Name
    remove_lighting
    Type
    boolean
    डिफ़ॉल्ट true
    Description

    बेस कलर टेक्सचर से highlights और shadows हटाता है, जिससे एक साफ़ परिणाम मिलता है जो कस्टम लाइटिंग सेटअप के अंतर्गत बेहतर काम करता है।

    केवल तब समर्थित जब ai_model meshy-6 या latest हो।

  • Name
    moderation
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    true पर सेट होने पर, इनपुट सामग्री को संभावित रूप से हानिकारक सामग्री के लिए स्वचालित रूप से स्क्रीन किया जाएगा। यदि हानिकारक सामग्री का पता चलता है, तो टास्क जनरेशन के लिए आगे नहीं बढ़ेगा।

    image_url, texture_image_url, और texture_prompt इनपुट से आई सामग्री को स्क्रीन किया जाएगा।

  • Name
    target_formats
    Type
    string[]
    Description

    निर्दिष्ट करता है कि आउटपुट में कौन-से 3D फ़ाइल फ़ॉर्मैट शामिल करने हैं। केवल अनुरोधित फ़ॉर्मैट जनरेट और लौटाए जाएँगे, जिससे टास्क पूरा होने का समय कम हो सकता है। छोड़े जाने पर, सभी समर्थित फ़ॉर्मैट शामिल किए जाते हैं।

    उपलब्ध मान: glb, obj, fbx, stl, usdz, 3mf

    छोड़े जाने पर, 3mf को छोड़कर सभी फ़ॉर्मैट जनरेट किए जाते हैं। 3mf केवल स्पष्ट रूप से निर्दिष्ट किए जाने पर शामिल होता है।

  • Name
    auto_size
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    true पर सेट होने पर, सेवा ऑब्जेक्ट की वास्तविक दुनिया की ऊँचाई का स्वचालित अनुमान लगाने और मॉडल का आकार उसी अनुसार रीसाइज़ करने के लिए AI vision का उपयोग करती है। जब तक origin_at स्पष्ट रूप से सेट न हो, ओरिजिन डिफ़ॉल्ट रूप से bottom होगा।

  • Name
    alpha_thumbnail
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    true पर सेट होने पर, टास्क preview का एक पारदर्शी-बैकग्राउंड (RGBA) संस्करण भी render करता है और उसे GET response में alpha_thumbnail_url के रूप में लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहता है।

  • Name
    multi_view_thumbnails
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    true पर सेट होने पर, टास्क चार cardinal-view thumbnails (front, right, back, left) भी render करता है और उन्हें GET response में thumbnail_urls के अंतर्गत लौटाता है। मौजूदा thumbnail_url फ़ील्ड अपरिवर्तित रहता है और front view की ओर संकेत करना जारी रखता है, इसलिए मौजूदा clients प्रभावित नहीं होते।

    टास्क latency में लगभग 3 सेकंड जोड़ता है।

केवल तब लागू होता है जब auto_size = true
  • Name
    origin_at
    Type
    string
    डिफ़ॉल्ट bottom
    Description

    auto_size सक्षम होने पर ओरिजिन की स्थिति।

    उपलब्ध मान: bottom, center.

Returns

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

Failure Modes

  • Name
    400 - Bad Request
    Description

    अनुरोध स्वीकार्य नहीं था। सामान्य कारण:

    • गुम पैरामीटर: image_url या input_task_id में से कोई एक दिया जाना चाहिए।
    • अमान्य input task: input_task_id को ऐसे SUCCEEDED टेक्स्ट से इमेज या इमेज से इमेज टास्क को संदर्भित करना चाहिए जो ठीक एक इमेज उत्पन्न करता हो।
    • अमान्य image format: दिया गया image_url समर्थित फ़ॉर्मैट (.jpg, .jpeg, .png) नहीं है।
    • अप्राप्य URL: image_url डाउनलोड नहीं किया जा सका (404 या timeout)।
    • अमान्य Data URI: base64 स्ट्रिंग malformed है।
    • अमान्य पैरामीटर संयोजन: enable_pbr केवल तब समर्थित है जब should_texture true हो।
  • Name
    401 - Unauthorized
    Description

    प्रमाणीकरण विफल रहा। कृपया अपनी API की जाँचें।

  • Name
    402 - Payment Required
    Description

    इस टास्क को करने के लिए अपर्याप्त क्रेडिट।

  • Name
    429 - Too Many Requests
    Description

    आपने अपनी रेट लिमिट पार कर ली है।

Request

POST
/openapi/v1/image-to-3d
# Simple request with required params
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -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>"
  }'

# With remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -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>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
GET/openapi/v1/image-to-3d/:id

इमेज से 3D कार्य प्राप्त करें

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

पैरामीटर

  • Name
    id
    Type
    path
    Description

    प्राप्त किए जाने वाले इमेज से 3D कार्य के लिए अद्वितीय पहचानकर्ता।

रिटर्न

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

Request

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}
DELETE/openapi/v1/image-to-3d/:id

इमेज से 3D टास्क हटाएँ

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

पाथ पैरामीटर

  • Name
    id
    Type
    path
    Description

    हटाए जाने वाले इमेज से 3D टास्क की ID।

रिटर्न

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

Request

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

Response

// Returns 200 Ok on success.
GET/openapi/v1/image-to-3d

इमेज से 3D कार्यों की सूची

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

पैरामीटर

वैकल्पिक एट्रिब्यूट्स

  • Name
    page_num
    Type
    integer
    Description

    पेजिनेशन के लिए पेज नंबर। 1 से शुरू होता है और डिफ़ॉल्ट भी 1 है।

  • Name
    page_size
    Type
    integer
    Description

    पेज आकार सीमा। डिफ़ॉल्ट 10 आइटम है। अधिकतम अनुमत 50 आइटम हैं।

  • Name
    sort_by
    Type
    string
    Description

    सॉर्ट करने के लिए फ़ील्ड। उपलब्ध मान:

    • +created_at: निर्माण समय के आधार पर आरोही क्रम में सॉर्ट करें।
    • -created_at: निर्माण समय के आधार पर अवरोही क्रम में सॉर्ट करें।

रिटर्न

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

Request

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "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=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "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": 30
  }
]
GET/openapi/v1/image-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/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/image-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",
  "type": "image-to-3d",
  "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=***",
  "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=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}

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

इमेज से 3D टास्क ऑब्जेक्ट एक कार्य इकाई है जिसे Meshy एक इमेज इनपुट से 3D मॉडल जनरेट करने के लिए ट्रैक करता है। ऑब्जेक्ट में निम्नलिखित प्रॉपर्टीज़ होती हैं:

प्रॉपर्टीज

  • Name
    id
    Type
    string
    Description

    टास्क के लिए यूनिक आइडेंटिफ़ायर। हालांकि हम टास्क ids के लिए इम्प्लीमेंटेशन डिटेल के रूप में k-sortable UUID का उपयोग करते हैं, आपको id के फ़ॉर्मैट के बारे में कोई भी अनुमान नहीं लगाना चाहिए।

  • Name
    type
    Type
    string
    Description

    इमेज से 3D टास्क का प्रकार। मान image-to-3d है।

  • Name
    model_urls
    Type
    object
    Description

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

    • Name
      glb
      Type
      string
      Description

      GLB फ़ाइल का डाउनलोड करने योग्य URL।

    • Name
      fbx
      Type
      string
      Description

      FBX फ़ाइल का डाउनलोड करने योग्य URL।

    • Name
      obj
      Type
      string
      Description

      OBJ फ़ाइल का डाउनलोड करने योग्य URL।

    • Name
      usdz
      Type
      string
      Description

      USDZ फ़ाइल का डाउनलोड करने योग्य URL।

    • Name
      mtl
      Type
      string
      Description

      MTL फ़ाइल का डाउनलोड करने योग्य URL, जब टेक्सचर मौजूद हों तो OBJ एक्सपोर्ट्स के साथ लौटाया जाता है।

    • Name
      stl
      Type
      string
      Description

      STL फ़ाइल का डाउनलोड करने योग्य URL।

    • Name
      3mf
      Type
      string
      Description

      3MF फ़ाइल का डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब target_formats के माध्यम से 3mf का अनुरोध किया गया हो।

    • Name
      pre_remeshed_glb
      Type
      string
      Description

      रीमेशिंग से पहले मूल GLB आउटपुट का डाउनलोड करने योग्य URL।

      केवल तब उपलब्ध होता है जब टास्क should_remesh: true और save_pre_remeshed_model: true दोनों के साथ बनाया गया हो।

  • Name
    thumbnail_url
    Type
    string
    Description

    मॉडल फ़ाइल की थंबनेल इमेज का डाउनलोड करने योग्य URL। मौजूद होने पर thumbnail_urls.front के बराबर, बैकवर्ड कम्पैटिबिलिटी के लिए रखा गया है।

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    thumbnail_url के ट्रांसपेरेंट-बैकग्राउंड (RGBA) वर्शन का डाउनलोड करने योग्य URL। केवल तब मौजूद होता है जब टास्क alpha_thumbnail: true के साथ बनाया गया हो और ट्रांसपेरेंट प्रीव्यू सफलतापूर्वक रेंडर हुआ हो; अन्यथा यह फ़ील्ड छोड़ दी जाती है।

  • Name
    thumbnail_urls
    Type
    object
    Description

    जनरेट किए गए 3D मॉडल के चार कार्डिनल-व्यू थंबनेल के लिए डाउनलोड करने योग्य URLs। प्रत्येक मान 512×512 PNG का एक signed URL है, जिसे thumbnail_url जैसे ही materials और lighting के साथ रेंडर किया गया है। GLB डाउनलोड किए बिना बैच पाइपलाइनों में मॉडल को कई एंगल से प्रीव्यू करने के लिए उपयोगी।

    केवल तब मौजूद होता है जब टास्क multi_view_thumbnails: true के साथ बनाया गया हो और SUCCEEDED तक पहुँच चुका हो। पुराने टास्क और opt-in के बिना बनाए गए टास्क में यह फ़ील्ड शामिल नहीं होगी।

    • Name
      front
      Type
      string
      Description

      फ्रंट व्यू, vertical axis के चारों ओर 0° रोटेशन (thumbnail_url से मेल खाता है)।

    • Name
      right
      Type
      string
      Description

      राइट व्यू, 90° रोटेशन।

    • Name
      back
      Type
      string
      Description

      बैक व्यू, 180° रोटेशन।

    • Name
      left
      Type
      string
      Description

      लेफ़्ट व्यू, 270° रोटेशन।

  • Name
    texture_prompt
    Type
    string
    Description

    टेक्सचरिंग प्रक्रिया को गाइड करने के लिए उपयोग किया गया टेक्स्ट prompt।

  • Name
    texture_image_url
    Type
    string
    Description

    टेक्सचरिंग प्रक्रिया को गाइड करने के लिए उपयोग की गई टेक्सचर इमेज का डाउनलोड करने योग्य 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
    expires_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

      base color map इमेज का डाउनलोड करने योग्य URL।

    • Name
      metallic
      Type
      string
      Description

      metallic map इमेज का डाउनलोड करने योग्य URL।

      यदि टास्क enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ दी जाएगी।

    • Name
      normal
      Type
      string
      Description

      नॉर्मल मैप इमेज का डाउनलोड करने योग्य URL।

      यदि टास्क enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ दी जाएगी।

    • Name
      roughness
      Type
      string
      Description

      roughness map इमेज का डाउनलोड करने योग्य URL।

      यदि टास्क enable_pbr: false के साथ बनाया गया है, तो यह प्रॉपर्टी छोड़ दी जाएगी।

    • Name
      emission
      Type
      string
      Description

      emission map इमेज का डाउनलोड करने योग्य 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

    इस टास्क द्वारा consume किए गए क्रेडिट की संख्या। तब मौजूद होता है जब टास्क स्थिति PENDING, IN_PROGRESS, या SUCCEEDED हो। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट रिफ़ंड कर दिए जाते हैं)।

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}