หลายรูปเป็น 3D API
หลายรูปเป็น 3D API เป็นฟีเจอร์ที่ช่วยให้คุณสามารถผนวกความสามารถด้านหลายรูปเป็น 3D ของ Meshy เข้ากับแอปพลิเคชันของคุณเองได้ ในส่วนนี้ คุณจะพบข้อมูลทั้งหมด ที่จำเป็นสำหรับการเริ่มต้นใช้งาน API นี้
สร้างงาน Multi-Image to 3D
เอนด์พอยต์นี้ช่วยให้คุณสามารถสร้างงาน หลายรูปเป็น 3D ใหม่ได้ ดูข้อมูลเพิ่มเติมได้ที่ The Multi-Image to 3D Task Object เพื่อดูว่า properties ใดบ้างที่รวมอยู่ใน Multi-Image to 3D task object
งานนี้จะทำงานในพื้นหลัง สำหรับระยะเวลาที่มักใช้ โปรดดู Processing Times
พารามิเตอร์
จำเป็นต้องระบุเพียงอย่างใดอย่างหนึ่งระหว่าง input_task_id หรือ image_urls หากระบุทั้งสองอย่าง input_task_id จะมีลำดับความสำคัญก่อน
- Name
- input_task_id
- Type
- string
- จำเป็น
- Description
ID ของงานสร้างรูปภาพที่เสร็จสมบูรณ์แล้ว ซึ่งผลลัพธ์ (1-4 รูปภาพ) จะถูกนำมาใช้เป็นอินพุต งานนี้ต้องเป็นหนึ่งในงานต่อไปนี้: ข้อความเป็นรูปภาพ, รูปภาพเป็นรูปภาพ, Text to Image Multi-View หรือ Image to Image Multi-View นอกจากนี้ยังต้องรันผ่าน API และมีสถานะเป็น
SUCCEEDED
- Name
- image_urls
- Type
- array
- จำเป็น
- Description
ระบุรูปภาพ 1 ถึง 4 รูปเพื่อให้ Meshy ใช้ในการสร้างโมเดล ขณะนี้เรารองรับรูปแบบ
.jpg,.jpeg,.pngและ.webpรูปภาพทั้งหมดควรแสดงวัตถุชิ้นเดียวกันจากมุมที่ต่างกัน เพื่อให้ได้ผลลัพธ์ที่ดีที่สุดขนาดไฟล์สูงสุด: 20 MB ต่อรูปภาพ
มีสองวิธีในการระบุรูปภาพแต่ละรูป:
- URL ที่เข้าถึงได้แบบสาธารณะ: URL ที่สามารถเข้าถึงได้จากอินเทอร์เน็ตสาธารณะ
- Data URI: data URI ของรูปภาพที่เข้ารหัสแบบ base64 ตัวอย่างของ data URI:
data:image/jpeg;base64,<your base64-encoded image data>
สำหรับ
meshy-7.1(หรือlatest) รูปภาพแรกจะถูกใช้เป็นมุมมองหลัก (ด้านหน้า) ลำดับของรูปภาพที่เหลือไม่สำคัญ
- Name
- ai_model
- Type
- string
- ค่าเริ่มต้น latest
- Description
ID ของโมเดลที่จะใช้
ค่าที่ใช้ได้:
meshy-6-lite,meshy-6,meshy-7.1,latest(Meshy 7.1)meshy-7(เลิกใช้): ให้ใช้meshy-7.1แทน
- Name
- geometry_resolution
- Type
- string
- ค่าเริ่มต้น standard
- Description
รอบการสร้างจีออเมทรี
2kจะรันรอบ Ultra ที่ความละเอียด 2048³ ต้องใช้meshy-7.1หรือlatestค่าที่ใช้ได้:
standard,2k
- Name
- ultra_mode
- Type
- boolean
- ⚠ เลิกใช้แล้ว
- ค่าเริ่มต้น false
- Description
ให้ใช้
geometry_resolutionแทนultra_mode: trueมีค่าเทียบเท่ากับgeometry_resolution: "2k"
- Name
- should_texture
- Type
- boolean
- ค่าเริ่มต้น true
- Description
กำหนดว่าจะสร้างเท็กซ์เจอร์หรือไม่ หากตั้งค่าเป็น
falseจะข้ามขั้นตอนการสร้างเท็กซ์เจอร์ ทำให้ได้เมชที่ไม่มีเท็กซ์เจอร์
should_texture = true- Name
- enable_pbr
- Type
- boolean
- ค่าเริ่มต้น false
- Description
สร้าง PBR แมป (metallic, roughness, normal) นอกเหนือจากสีพื้นฐาน นอกจากนี้จะมี emission map รวมอยู่ด้วยเมื่อ
ai_modelเป็นmeshy-6ยกเว้นที่texture_resolution: 8kโดยmeshy-6-lite,meshy-7.1และlatestจะไม่สร้าง emission map
- Name
- texture_resolution
- Type
- string
- ค่าเริ่มต้น 2k
- Description
ความละเอียดของเท็กซ์เจอร์สีพื้นฐาน เลือกได้ระหว่าง
2k(2048×2048),4k(4096×4096) หรือ8k(8192×8192) ความละเอียดที่สูงกว่าจะจับรายละเอียดพื้นผิวได้มากขึ้น4kและ8kต้องใช้ai_modelเป็นmeshy-6,meshy-7.1หรือlatestที่8kจะไม่มีการสร้าง emission map
- Name
- hd_texture
- Type
- boolean
- ⚠ เลิกใช้แล้ว
- ค่าเริ่มต้น false
- Description
ให้ใช้
texture_resolutionแทน — เทียบเท่ากับtexture_resolution: "4k"เมื่อตั้งค่าทั้งสองอย่างtexture_resolutionจะมีความสำคัญก่อน
- Name
- texture_prompt
- Type
- string
- Description
ระบุ prompt ข้อความเพื่อกำกับขั้นตอนการสร้างเท็กซ์เจอร์ สูงสุด 800 ตัวอักษร
- Name
- texture_image_url
- Type
- string
- Description
ระบุรูปภาพ 2 มิติเพื่อกำกับขั้นตอนการสร้างเท็กซ์เจอร์ ขณะนี้เรารองรับรูปแบบ
.jpg,.jpeg,.pngและ.webpขนาดไฟล์สูงสุด: 20 MB
มีสองวิธีในการระบุรูปภาพ:
- URL ที่เข้าถึงได้แบบสาธารณะ: URL ที่สามารถเข้าถึงได้จากอินเทอร์เน็ตสาธารณะ
- Data URI: data URI ของรูปภาพที่เข้ารหัสแบบ base64 ตัวอย่างของ data URI:
data:image/jpeg;base64,<your base64-encoded image data>
การสร้างเท็กซ์เจอร์จากรูปภาพอาจทำงานได้ไม่ดีนักหากมีความแตกต่างด้านจีออเมทรีมากระหว่างชิ้นงานต้นฉบับกับรูปภาพที่อัปโหลด สามารถใช้ได้เพียงอย่างใดอย่างหนึ่งระหว่าง
texture_image_urlหรือtexture_promptในการกำกับขั้นตอนการสร้างเท็กซ์เจอร์ หากระบุทั้งสองพารามิเตอร์ ระบบจะใช้texture_promptในการสร้างเท็กซ์เจอร์ของโมเดลเป็นค่าเริ่มต้น
- Name
- texture_image_urls
- Type
- string[]
- Description
ระบุรูปภาพ 1 ถึง 4 รูปที่แสดงวัตถุชิ้นเดียวกันจากมุมมองต่างกัน เพื่อกำกับการสร้างเท็กซ์เจอร์ รูปภาพแรกคือมุมมองหลัก (ด้านหน้า) ส่วนลำดับของมุมมองที่เหลือ (ซ้าย, หลัง, ขวา) ไม่สำคัญ
แต่ละองค์ประกอบรองรับรูปแบบเดียวกันกับ
texture_image_url(URL ที่เข้าถึงได้แบบสาธารณะ หรือ base64 data URI ในรูปแบบ.jpg/.jpeg/.png/.webp)ขนาดไฟล์สูงสุด: 20 MB ต่อรูปภาพ
รูปภาพเหล่านี้ใช้กำกับเท็กซ์เจอร์เท่านั้น และเป็นอิสระจาก
image_urls— รายการทั้งสองสามารถมีรูปภาพที่แตกต่างกันและจำนวนรูปภาพที่แตกต่างกันได้ต้องใช้
ai_modelเป็นmeshy-7.1หรือlatestไม่สามารถใช้ร่วมกับtexture_image_urlหรือtexture_promptได้
- Name
- should_remesh
- Type
- boolean
- ค่าเริ่มต้น false (Meshy 6 and Meshy 7 models), true (others)
- Description
ควบคุมว่าจะเปิดใช้งานขั้นตอนการรีเมชหรือไม่ สำหรับโมเดลที่มีคุณภาพสูงสุด เราแนะนำให้ตั้งค่า
should_remeshเป็นfalse
should_remesh = true- Name
- topology
- Type
- string
- ค่าเริ่มต้น triangle
- Description
ระบุ topology ของโมเดลที่สร้างขึ้น
ค่าที่ใช้ได้:
quad: สร้างเมชที่ส่วนใหญ่เป็น quadtriangle: สร้างเมชสามเหลี่ยมแบบลดจำนวนโพลิกอน
- Name
- target_polycount
- Type
- integer
- ค่าเริ่มต้น 30,000
- Description
ระบุจำนวนโพลิกอนเป้าหมายในโมเดลที่สร้างขึ้น จำนวนโพลิกอนที่แท้จริงอาจแตกต่างจากเป้าหมาย ขึ้นอยู่กับความซับซ้อนของจีออเมทรี
ช่วงที่ใช้ได้คือ 100 ถึง 300,000 (รวมค่าทั้งสองด้าน)
- Name
- decimation_mode
- Type
- integer
- Description
เปิดใช้งานการลดจำนวนโพลิกอนแบบปรับตัวได้โดยตั้งค่าระดับจำนวนโพลิกอน เมื่อตั้งค่านี้
target_polycountจะถูกละเว้นค่าที่ใช้ได้:
1: ปรับตัวได้ — จำนวนโพลิกอนระดับสูงสุด2: ปรับตัวได้ — จำนวนโพลิกอนระดับสูง3: ปรับตัวได้ — จำนวนโพลิกอนระดับปานกลาง4: ปรับตัวได้ — จำนวนโพลิกอนระดับต่ำ
- Name
- save_pre_remeshed_model
- Type
- boolean
- ค่าเริ่มต้น false
- Description
เมื่อตั้งค่าเป็น
trueMeshy จะจัดเก็บไฟล์ GLB เพิ่มเติมก่อนที่ขั้นตอนการรีเมชจะเสร็จสมบูรณ์
- Name
- symmetry_mode
- Type
- string
- ⚠ เลิกใช้แล้ว
- ค่าเริ่มต้น auto
- Description
เลิกใช้แล้ว พารามิเตอร์นี้ไม่มีผลต่อผลลัพธ์อีกต่อไป
ฟิลด์
symmetry_modeควบคุมพฤติกรรมสมมาตรระหว่างกระบวนการสร้างโมเดลค่าที่ใช้ได้มีดังนี้:
off: ปิดใช้งานสมมาตรauto: กำหนดและนำสมมาตรไปใช้โดยอัตโนมัติตามจีออเมทรีของอินพุตon: บังคับใช้สมมาตรระหว่างการสร้าง
- Name
- pose_mode
- Type
- string
- ค่าเริ่มต้น ""
- Description
ระบุ pose mode ของโมเดลที่สร้างขึ้น
ค่าที่ใช้ได้:
a-pose: สร้างโมเดลในท่า At-pose: สร้างโมเดลในท่า T""(สตริงว่าง): ไม่มีการกำหนดท่าเฉพาะ
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ เลิกใช้แล้ว
- ค่าเริ่มต้น false
- Description
ให้ใช้
pose_modeแทน ระบุว่าจะสร้างโมเดลในท่า A/T หรือไม่
- Name
- image_enhancement
- Type
- boolean
- ค่าเริ่มต้น true
- Description
ปรับแต่งรูปภาพอินพุตเพื่อให้ได้ผลลัพธ์ที่ดีขึ้น ตั้งค่าเป็น
falseเพื่อคงลักษณะที่ปรากฏของรูปภาพอินพุตไว้อย่างแม่นยำโดยไม่มีการประมวลผลสไตล์ใดๆรองรับเฉพาะเมื่อ
ai_modelเป็นmeshy-6,meshy-7.1หรือlatestการตั้งค่านี้กับmeshy-6-liteจะคืนค่าข้อผิดพลาด
- Name
- remove_lighting
- Type
- boolean
- ค่าเริ่มต้น true
- Description
ลบไฮไลต์และเงาออกจากเท็กซ์เจอร์สีพื้นฐาน ทำให้ได้ผลลัพธ์ที่สะอาดขึ้น ซึ่งทำงานได้ดีกว่าภายใต้การตั้งค่าแสงแบบกำหนดเอง
รองรับเฉพาะเมื่อ
ai_modelเป็นmeshy-6,meshy-7.1หรือlatestการตั้งค่านี้กับmeshy-6-liteจะคืนค่าข้อผิดพลาด
- Name
- moderation
- Type
- boolean
- ค่าเริ่มต้น false
- Description
เมื่อตั้งค่าเป็น
trueเนื้อหาอินพุตจะถูกตรวจสอบโดยอัตโนมัติเพื่อหาเนื้อหาที่อาจเป็นอันตราย หากตรวจพบเนื้อหาที่เป็นอันตราย งานจะไม่ดำเนินการต่อไปยังขั้นตอนการสร้างรูปภาพแต่ละรูปจาก
image_urlsและข้อความจาก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 เพื่อประมาณความสูงจริงของวัตถุโดยอัตโนมัติ และปรับขนาดโมเดลให้สอดคล้องกัน จุดกำเนิดจะเป็นค่าเริ่มต้นที่bottomเว้นแต่จะมีการตั้งค่าorigin_atอย่างชัดเจน
- Name
- alpha_thumbnail
- Type
- boolean
- ค่าเริ่มต้น false
- Description
เมื่อตั้งค่าเป็น
trueงานจะเรนเดอร์ภาพตัวอย่างแบบพื้นหลังโปร่งใส (RGBA) เพิ่มเติม และส่งคืนเป็นalpha_thumbnail_urlในการตอบกลับของ GET ฟิลด์thumbnail_urlที่มีอยู่เดิมจะไม่เปลี่ยนแปลง
- Name
- multi_view_thumbnails
- Type
- boolean
- ค่าเริ่มต้น false
- Description
เมื่อตั้งค่าเป็น
trueงานจะเรนเดอร์ภาพตัวอย่างสี่มุมมองหลัก (หน้า, ขวา, หลัง, ซ้าย) เพิ่มเติม และส่งคืนภายใต้thumbnail_urlsในการตอบกลับของ GET ฟิลด์thumbnail_urlที่มีอยู่เดิมจะไม่เปลี่ยนแปลง และยังคงชี้ไปที่มุมมองด้านหน้า ดังนั้นไคลเอนต์ที่มีอยู่เดิมจะไม่ได้รับผลกระทบเพิ่มเวลาแฝงของงานประมาณ 3 วินาที
auto_size = true- Name
- origin_at
- Type
- string
- ค่าเริ่มต้น bottom
- Description
ตำแหน่งของจุดกำเนิดเมื่อเปิดใช้งาน
auto_sizeค่าที่ใช้ได้:bottom,center
ผลลัพธ์ที่ส่งคืน
พร็อพเพอร์ตี้ result ของการตอบกลับประกอบด้วย id ของงาน หลายรูปเป็น 3D ที่สร้างขึ้นใหม่
รูปแบบความล้มเหลว
- Name
400 - Bad Request- Description
คำขอไม่สามารถยอมรับได้ สาเหตุทั่วไป:
- ขาดพารามิเตอร์: ต้องระบุ
image_urlsหรือinput_task_idอย่างใดอย่างหนึ่ง - งานอินพุตไม่ถูกต้อง:
input_task_idต้องอ้างอิงถึงงาน ข้อความเป็นรูปภาพ, รูปภาพเป็นรูปภาพ หรือรูปแบบมุมมองหลายด้านที่มีสถานะSUCCEEDED - จำนวนรูปภาพไม่ถูกต้อง:
image_urlsต้องมีรูปภาพระหว่าง 1 ถึง 4 รูป และtexture_image_urlsระหว่าง 1 ถึง 4 รูป - รูปแบบรูปภาพไม่ถูกต้อง: รูปภาพอย่างน้อยหนึ่งรูปใน
image_urlsอยู่ในรูปแบบที่ไม่รองรับ - อินพุตเท็กซ์เจอร์ขัดแย้งกัน:
texture_image_urlsไม่สามารถใช้ร่วมกับtexture_image_urlหรือtexture_promptได้ และต้องมีshould_texture: true - โมเดลไม่รองรับเท็กซ์เจอร์แบบมุมมองหลายด้าน:
texture_image_urlsต้องใช้ai_modelเป็นmeshy-7.1หรือlatest - ไม่สามารถเข้าถึง URL ได้: ไม่สามารถดาวน์โหลดองค์ประกอบอย่างน้อยหนึ่งรายการใน
image_urlsหรือtexture_image_urlsได้ - รูปภาพใหญ่เกินไป: รูปภาพอย่างน้อยหนึ่งรูปใน
image_urls,texture_image_urlหรือtexture_image_urlsมีขนาดเกิน 20 MB - ความละเอียดไม่รองรับสำหรับอินพุตหลายรูปภาพ:
geometry_resolution: "4k"ไม่สามารถใช้ได้กับเอนด์พอยต์นี้ ให้ใช้2kหรือstandardแทน - โมเดลไม่รองรับตัวเลือกรูปภาพ: มีการตั้งค่า
image_enhancementหรือremove_lightingร่วมกับai_model: "meshy-6-lite"
- ขาดพารามิเตอร์: ต้องระบุ
- Name
401 - Unauthorized- Description
การยืนยันตัวตนล้มเหลว โปรดตรวจสอบ API คีย์ของคุณ
- Name
402 - Payment Required- Description
เครดิตไม่เพียงพอสำหรับการทำงานนี้
- Name
429 - Too Many Requests- Description
คุณได้เกินการจำกัดอัตราแล้ว
Request
# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your publicly accessible image url or base64-encoded data URI>",
"<your second publicly accessible image url or base64-encoded data URI>"
]
}'
# With Ultra 2K geometry, PBR texturing and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your publicly accessible image url or base64-encoded data URI>",
"<your second publicly accessible image url or base64-encoded data URI>"
],
"ai_model": "meshy-7.1",
"geometry_resolution": "2k",
"should_texture": true,
"enable_pbr": true,
"target_formats": ["glb"]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
ดึงข้อมูล Multi-Image to 3D Task
เอนด์พอยต์นี้ช่วยให้คุณดึงข้อมูลงาน Multi-Image to 3D โดยใช้ id ของงานที่ถูกต้อง
ดู The Multi-Image to 3D Task Object เพื่อดูว่า
properties ใดบ้างที่รวมอยู่ใน Multi-Image to 3D task object
พารามิเตอร์
- Name
- id
- Type
- path
- Description
ตัวระบุเฉพาะ (Unique identifier) สำหรับงาน Multi-Image to 3D ที่ต้องการดึงข้อมูล
ค่าที่ส่งกลับ
การตอบกลับประกอบด้วย Multi-Image to 3D task object ดูรายละเอียดได้ที่ส่วน The Multi-Image to 3D Task Object
Request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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 อย่างถาวร รวมถึงโมเดลและข้อมูลทั้งหมดที่เกี่ยวข้อง การกระทำนี้ไม่สามารถย้อนกลับได้
Path Parameters
- Name
- id
- Type
- path
- Description
ID ของงานหลายรูปเป็น 3D ที่ต้องการลบ
สถานะงาน
งานที่ยังอยู่ในสถานะ PENDING จะถูกลบและเครดิตที่ถูกใช้ไปตอนสร้างงานจะถูกคืนให้
งานที่อยู่ในสถานะ IN_PROGRESS ไม่สามารถลบได้ คำขอจะถูกปฏิเสธด้วย
409 Conflict และงานจะยังคงทำงานต่อไป เครดิตสำหรับงานที่ worker
เริ่มดำเนินการไปแล้วจะไม่สามารถขอคืนได้ ดังนั้นการลบงานระหว่างที่กำลังทำงานอยู่
จะทำให้คุณเสียทั้งเครดิตและผลลัพธ์ ให้รอจนกว่างานจะถึงสถานะ
SUCCEEDED, FAILED หรือ CANCELED แล้วจึงลบ
งานที่อยู่ในสถานะสุดท้าย (SUCCEEDED, FAILED หรือ CANCELED) จะถูกลบ
โดยไม่มีการคืนเครดิต
ผลลัพธ์ที่ได้รับ
คืนค่า 200 OK เมื่อสำเร็จ หรือ 409 Conflict เมื่องานอยู่ในสถานะ
IN_PROGRESS
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
"message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}
แสดงรายการ Tasks ของหลายรูปเป็น 3D
เอนด์พอยต์นี้ช่วยให้คุณสามารถดึงรายการ Tasks ของหลายรูปเป็น 3D ได้
พารามิเตอร์
แอตทริบิวต์ที่ไม่บังคับ
- Name
- page_num
- Type
- integer
- Description
หมายเลขหน้าสำหรับการแบ่งหน้า เริ่มต้นและมีค่าเริ่มต้นเป็น
1
- Name
- page_size
- Type
- integer
- Description
จำนวนรายการต่อหน้า ค่าเริ่มต้นคือ
10รายการ สูงสุดที่อนุญาตคือ100รายการ
- Name
- sort_by
- Type
- string
- Description
ฟิลด์ที่ใช้สำหรับการเรียงลำดับ ค่าที่สามารถใช้ได้:
+created_at: เรียงลำดับตามเวลาที่สร้างจากน้อยไปมาก-created_at: เรียงลำดับตามเวลาที่สร้างจากมากไปน้อย
ค่าที่ส่งกลับ
ส่งคืนรายการแบบแบ่งหน้าของ The Multi-Image to 3D Task Objects
Request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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
}
]
Stream a Multi-Image to 3D Task
เอนด์พอยต์นี้สตรีมอัปเดตแบบเรียลไทม์สำหรับงานหลายรูปเป็น 3D โดยใช้ Server-Sent Events (SSE)
พารามิเตอร์
- Name
- id
- Type
- path
- Description
ตัวระบุเฉพาะสำหรับงานหลายรูปเป็น 3D ที่ต้องการสตรีม
ค่าที่ส่งกลับ
ส่งกลับสตรีมของ The Multi-Image to 3D Task Objects ในรูปแบบ Server-Sent Events
สำหรับงานที่มีสถานะ PENDING หรือ IN_PROGRESS สตรีมของการตอบกลับจะมีเฉพาะฟิลด์ progress และ status ที่จำเป็นเท่านั้น
Request
curl -N https://api.meshy.ai/openapi/v1/multi-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": "multi-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
}
The Multi-Image to 3D Task Object
อ็อบเจ็กต์ Multi-Image to 3D Task คือหน่วยงานที่ Meshy ใช้ติดตามการสร้างโมเดล 3D จากหลายรูปภาพ (ตั้งแต่ 1 ถึง 4 รูป) โดยรูปภาพควรเป็นวัตถุชิ้นเดียวกัน ควรถ่ายจากมุมมองหรือองศาที่แตกต่างกัน อ็อบเจ็กต์นี้มีคุณสมบัติดังต่อไปนี้
Properties
- Name
- id
- Type
- string
- Description
ตัวระบุเฉพาะสำหรับงาน แม้ว่าเราจะใช้ k-sortable UUID สำหรับ id ของงานเป็นรายละเอียดด้านการใช้งาน แต่คุณ ไม่ควร ตั้งสมมติฐานใดๆ เกี่ยวกับรูปแบบของ id
- Name
- type
- Type
- string
- Description
ประเภทของงาน Multi-Image to 3D ค่าของมันคือ
multi-image-to-3d
- Name
- model_urls
- Type
- object
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์โมเดล 3D ที่มีการลงเท็กซ์เจอร์แล้วซึ่งสร้างโดย Meshy พร็อพเพอร์ตี้สำหรับรูปแบบใดรูปแบบหนึ่งจะถูกละเว้นหากรูปแบบนั้นไม่ได้ถูกสร้างขึ้น แทนที่จะคืนค่าเป็นสตริงว่าง
- Name
glb- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ GLB
- Name
fbx- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ FBX
- Name
obj- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ OBJ
- Name
usdz- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ USDZ
- Name
mtl- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ MTL ซึ่งส่งคืนพร้อมกับการส่งออก OBJ เมื่อมีเท็กซ์เจอร์อยู่
- Name
stl- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ STL
- Name
3mf- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ 3MF จะปรากฏเฉพาะเมื่อมีการร้องขอ
3mfผ่านtarget_formats
- Name
pre_remeshed_glb- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับไฟล์ GLB ต้นฉบับก่อนการ remesh
มีให้เฉพาะเมื่องานถูกสร้างขึ้นด้วยทั้ง
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
URL ที่ดาวน์โหลดได้สำหรับเวอร์ชันพื้นหลังโปร่งใส (RGBA) ของ
thumbnail_urlจะปรากฏเฉพาะเมื่องานถูกสร้างขึ้นด้วยalpha_thumbnail: trueและภาพตัวอย่างโปร่งใสถูกเรนเดอร์สำเร็จเท่านั้น มิฉะนั้นฟิลด์นี้จะถูกละเว้น
- Name
- thumbnail_urls
- Type
- object
- Description
URL ที่ดาวน์โหลดได้สำหรับภาพย่อสี่มุมมองหลักของโมเดล 3D ที่สร้างขึ้น แต่ละค่าเป็น URL ที่ลงนามแล้วสำหรับภาพ PNG ขนาด 512×512 ที่เรนเดอร์ด้วยวัสดุและแสงเดียวกันกับ
thumbnail_urlมีประโยชน์สำหรับการแสดงตัวอย่างโมเดลจากหลายมุมในไปป์ไลน์แบบกลุ่มโดยไม่ต้องดาวน์โหลด GLBมีให้เฉพาะเมื่องานถูกสร้างขึ้นด้วย
multi_view_thumbnails: trueและมีสถานะถึงSUCCEEDEDแล้ว งานที่สร้างไว้ก่อนหน้าและงานที่สร้างขึ้นโดยไม่ได้เปิดใช้ตัวเลือกนี้จะไม่มีฟิลด์นี้- Name
- front
- Type
- string
- Description
มุมมองด้านหน้า หมุน 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_urls
- Type
- string[]
- Description
URL ที่ดาวน์โหลดได้สำหรับรูปภาพอ้างอิงเท็กซ์เจอร์ที่ใช้ในการสร้างงาน เรียงตามลำดับที่ให้มา จะปรากฏเฉพาะเมื่องานถูกสร้างขึ้นด้วย
texture_image_urls
- Name
- ultra_mode
- Type
- boolean
- ⚠ เลิกใช้แล้ว
- Description
เลิกใช้แล้ว โปรดอ่าน
geometry_resolutionแทน
- Name
- geometry_resolution
- Type
- string
- Description
ระดับ Ultra ที่งานนี้ทำงาน (
2k) จะถูกละเว้นสำหรับstandard
- Name
- progress
- Type
- integer
- Description
ความคืบหน้าของงาน หากงานยังไม่เริ่ม พร็อพเพอร์ตี้นี้จะเป็น
0เมื่องานสำเร็จแล้ว ค่านี้จะกลายเป็น100
- Name
- started_at
- Type
- timestamp
- Description
ไทม์สแตมป์ของเวลาที่งานเริ่มต้น หน่วยเป็นมิลลิวินาที หากงานยังไม่เริ่ม พร็อพเพอร์ตี้นี้จะเป็น
0ไทม์สแตมป์แสดงถึงจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่วันที่ 1 มกราคม 1970 UTC ตามมาตรฐาน RFC 3339
ตัวอย่างเช่น วันศุกร์ที่ 1 กันยายน 2023 เวลา 12:00:00 น. 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 เท็กซ์เจอร์ที่สร้างขึ้นจากงาน โดยปกติแล้วจะมีอ็อบเจ็กต์ URL เท็กซ์เจอร์เพียง หนึ่ง รายการเท่านั้น แต่ละ URL เท็กซ์เจอร์มีคุณสมบัติดังต่อไปนี้
- Name
base_color- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับภาพแมปสีพื้นฐาน
- Name
metallic- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับภาพแมปโลหะ
หากงานถูกสร้างขึ้นด้วย
enable_pbr: falseพร็อพเพอร์ตี้นี้จะถูกละเว้น
- Name
normal- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับภาพนอร์มัลแมป
หากงานถูกสร้างขึ้นด้วย
enable_pbr: falseพร็อพเพอร์ตี้นี้จะถูกละเว้น
- Name
roughness- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับภาพแมปความขรุขระ
หากงานถูกสร้างขึ้นด้วย
enable_pbr: falseพร็อพเพอร์ตี้นี้จะถูกละเว้น
- Name
emission- Type
- string
- Description
URL ที่ดาวน์โหลดได้สำหรับภาพแมปการเปล่งแสง
หากงานถูกสร้างขึ้นด้วย
enable_pbr: falseหรือai_modelเป็นmeshy-6-lite,meshy-7.1, หรือlatestพร็อพเพอร์ตี้นี้จะถูกละเว้น
- 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จะคืนค่า0สำหรับงานที่FAILED(เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)
Example Multi-Image to 3D Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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,
}