UV अनरैप API

UV अनरैप API किसी मौजूदा 3D मॉडल के लिए स्वचालित रूप से उच्च-गुणवत्ता वाला UV अनरैप जनरेट करता है। टेक्सचरिंग से पहले इसे पूर्वापेक्षित चरण के रूप में उपयोग करें — या जब भी आपको डाउनस्ट्रीम टूल्स (Blender, Substance Painter, Unreal) के लिए एक साफ़, बिना ओवरलैप वाला UV लेआउट चाहिए।

आउटपुट एक "UV व्हाइट मॉडल" होता है — इनपुट जैसी ही आकृति, लेकिन बिल्कुल नए UV निर्देशांक और बिना किसी वास्तविक टेक्सचर के (glTF मटेरियल स्लॉट को वैध रखने के लिए 2×2 ग्रे प्लेसहोल्डर मटेरियल शामिल है; मानक टूल्स इसे अनटेक्सचर्ड मानते हैं)।


POST/openapi/v1/uv-unwrap

UV अनरैप कार्य बनाएँ

यह एंडपॉइंट एक नया UV अनरैप कार्य बनाता है।

पैरामीटर

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

    पूर्ण हुए Meshy API कार्य की ID जिसका GLB आउटपुट आप UV अनरैप करना चाहते हैं (उदाहरण के लिए इमेज से 3D, टेक्स्ट से 3D, या रीमेश परिणाम)। स्रोत कार्य की स्थिति SUCCEEDED होनी चाहिए और उसने GLB फ़ाइल बनाई होनी चाहिए।

    यदि स्रोत मेश 40,000 फ़ेस की face-count सीमा से अधिक है, तो अनुरोध 400 के साथ अस्वीकार कर दिया जाएगा और पॉलीकाउंट कम करने के लिए आपको पहले रीमेश चलाना चाहिए।

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

    सार्वजनिक रूप से पहुँच योग्य URL या Data URI के माध्यम से सीधे 3D मॉडल प्रदान करें। केवल .glb समर्थित है — API glTF बाइनरी पढ़ता है और अन्य फ़ॉर्मैट्स को पार्स नहीं करता। किसी अन्य फ़ॉर्मैट (.fbx, .obj, .stl, .gltf) में मॉडल को UV अनरैप करने के लिए, पहले कन्वर्ट API के माध्यम से उसे .glb में कन्वर्ट करें, फिर परिणामी कार्य ID को input_task_id के रूप में या उसका GLB आउटपुट URL यहाँ पास करें।

    Data URIs के लिए, MIME type application/octet-stream का उपयोग करें।

    वही 40,000-फ़ेस सीमा लागू होती है जैसी input_task_id के लिए: अधिक बड़े मेश 400 के साथ अस्वीकार कर दिए जाते हैं — पहले रीमेश चलाएँ।

लौटाता है

प्रतिक्रिया की result प्रॉपर्टी में नए बनाए गए UV अनरैप कार्य का id होता है।

विफलता मोड

  • Name
    400 - Bad Request
    Description

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

    • अनुपस्थित पैरामीटर: या तो input_task_id या model_url प्रदान किया जाना चाहिए।
    • अमान्य इनपुट कार्य: input_task_id को GLB परिणाम वाले सफल कार्य को संदर्भित करना चाहिए।
    • फ़ेस संख्या सीमा से अधिक: स्रोत मेश में UV अनरैप सीमा से अधिक फ़ेस हैं। पहले रीमेश चलाएँ।
    • अमान्य मॉडल फ़ॉर्मैट: model_url असमर्थित एक्सटेंशन वाली फ़ाइल की ओर इंगित करता है।
    • अप्राप्य URL: model_url डाउनलोड नहीं किया जा सका।
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    इस कार्य को करने के लिए अपर्याप्त क्रेडिट। UV अनरैप की लागत प्रति कॉल 5 क्रेडिट है।

  • Name
    404 - Not Found
    Description

    यह सुविधा आपके खाते के लिए सक्षम नहीं है। रोलआउट के दौरान UV अनरैप एक Statsig फ़्लैग द्वारा नियंत्रित है — यदि आपको पहुँच चाहिए तो Meshy सहायता से संपर्क करें।

  • Name
    429 - Too Many Requests
    Description

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

Request

POST
/openapi/v1/uv-unwrap
# Chain from an existing Meshy task
curl https://api.meshy.ai/openapi/v1/uv-unwrap \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
      "input_task_id": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
    }'

# Or from a publicly accessible model URL
curl https://api.meshy.ai/openapi/v1/uv-unwrap \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
      "model_url": "https://example.com/path/to/model.glb"
    }'

Response

{
  "result": "019361c6-9b34-7b23-bef2-d0107c4d92e2"
}

GET/openapi/v1/uv-unwrap/:id

UV अनरैप टास्क प्राप्त करें

यह एंडपॉइंट ID द्वारा UV अनरैप टास्क की वर्तमान स्थिति प्राप्त करता है।

रिटर्न

एक UV अनरैप टास्क ऑब्जेक्ट लौटाता है।

Request

GET
/openapi/v1/uv-unwrap/:id
curl https://api.meshy.ai/openapi/v1/uv-unwrap/019361c6-9b34-7b23-bef2-d0107c4d92e2 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

नीचे उदाहरण टास्क ऑब्जेक्ट देखें।


DELETE/openapi/v1/uv-unwrap/:id

UV अनरैप कार्य हटाएँ

UV अनरैप कार्य को स्थायी रूप से हटाएँ। कार्य और उसके आउटपुट अप्राप्य हो जाते हैं।

Request

DELETE
/openapi/v1/uv-unwrap/:id
curl https://api.meshy.ai/openapi/v1/uv-unwrap/019361c6-9b34-7b23-bef2-d0107c4d92e2 \
-X DELETE \
-H "Authorization: Bearer ${YOUR_API_KEY}"

GET/openapi/v1/uv-unwrap

UV अनरैप कार्यों की सूची

कॉलर के UV अनरैप कार्यों की पेजिनेशन वाली सूची लौटाता है, सबसे नए पहले। page_num और page_size के माध्यम से मानक पेजिनेशन।

Request

GET
/openapi/v1/uv-unwrap
curl "https://api.meshy.ai/openapi/v1/uv-unwrap?page_num=1&page_size=20" \
-H "Authorization: Bearer ${YOUR_API_KEY}"

GET/openapi/v1/uv-unwrap/:id/stream

UV अनरैप टास्क को स्ट्रीम करें

Server-Sent Events के रूप में टास्क progress की सदस्यता लें। प्रत्येक message इवेंट एक UV अनरैप टास्क ऑब्जेक्ट लेकर आता है; टास्क के SUCCEEDED, FAILED, या CANCELED तक पहुँचते ही स्ट्रीम बंद हो जाती है।

पूर्णता पर कम लेटेंसी के लिए GET /openapi/v1/uv-unwrap/:id को पोल करने के बजाय इसका उपयोग करें।

Request

GET
/openapi/v1/uv-unwrap/:id/stream
curl https://api.meshy.ai/openapi/v1/uv-unwrap/019361c6-9b34-7b23-bef2-d0107c4d92e2/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-N

UV अनरैप टास्क ऑब्जेक्ट

  • Name
    id
    Type
    string
    Description

    टास्क के लिए अद्वितीय पहचानकर्ता।

  • Name
    type
    Type
    string
    Description

    हमेशा uv-unwrap

  • Name
    model_urls
    Type
    object
    Description

    जनरेट किए गए UV व्हाइट मॉडल के लिए प्री-साइन्ड डाउनलोड URL। UV अनरैप हमेशा एक ही glb एंट्री लौटाता है — आउटपुट इनपुट ज्यामिति को सुरक्षित रखता है, नए UV निर्देशांक लगाता है, और किसी भी टेक्सचर की जगह डिफ़ॉल्ट ग्रे मटेरियल का उपयोग करता है।

  • Name
    thumbnail_url
    Type
    string
    Description

    UV व्हाइट मॉडल के PNG प्रीव्यू के लिए प्री-साइन्ड URL।

  • Name
    progress
    Type
    integer
    Description

    टास्क progress, 0 से 100 तक।

  • Name
    status
    Type
    string
    Description

    PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक।

  • Name
    preceding_tasks
    Type
    integer
    Description

    इस टास्क से आगे कतार में लगे टास्क की संख्या। स्टेटस PENDING होने पर मौजूद होता है।

  • Name
    created_at
    Type
    timestamp
    Description

    टास्क निर्माण का टाइमस्टैंप, मिलीसेकंड में।

  • Name
    started_at
    Type
    timestamp
    Description

    प्रोसेसिंग शुरू होने का टाइमस्टैंप, मिलीसेकंड में। शुरू होने तक 0

  • Name
    finished_at
    Type
    timestamp
    Description

    पूरा होने का टाइमस्टैंप, मिलीसेकंड में। पूरा होने तक 0

  • Name
    expires_at
    Type
    timestamp
    Description

    वह टाइमस्टैंप जिसके बाद साइन किए गए डाउनलोड URL समाप्त हो जाते हैं, मिलीसेकंड में।

  • Name
    task_error
    Type
    object
    Description

    विफल टास्क के लिए एरर विवरण। पूर्ण task_error ऑब्जेक्ट संदर्भ के लिए एरर देखें।

  • Name
    consumed_credits
    Type
    integer
    Description

    इस टास्क द्वारा उपभोग किए गए क्रेडिट। FAILED टास्क के लिए 0 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)। UV अनरैप सफलता पर 5 क्रेडिट चार्ज करता है।

Example UV Unwrap Task Object

{
  "id": "019361c6-9b34-7b23-bef2-d0107c4d92e2",
  "type": "uv-unwrap",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019361c6-9b34-7b23-bef2-d0107c4d92e2/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019361c6-9b34-7b23-bef2-d0107c4d92e2/output/preview.png?Expires=***",
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1716579120000,
  "started_at": 1716579122000,
  "finished_at": 1716579180000,
  "expires_at": 1716665580000,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 5
}