API หลายรูปเป็น 3D

API หลายรูปเป็น 3D เป็นฟีเจอร์ที่ช่วยให้คุณผสานความสามารถหลายรูปเป็น 3D ของ Meshy เข้ากับแอปพลิเคชันของคุณเองได้ ในส่วนนี้ คุณจะพบข้อมูลทั้งหมด ที่จำเป็นสำหรับการเริ่มต้นใช้งาน API นี้

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

สร้างงานหลายรูปเป็น 3D

เอนด์พอยต์นี้ช่วยให้คุณสร้างงานหลายรูปเป็น 3D ใหม่ โปรดดู วัตถุงานหลายรูปเป็น 3D เพื่อดูว่า มีคุณสมบัติใดบ้างในวัตถุงานหลายรูปเป็น 3D

พารามิเตอร์

ต้องมีเพียงหนึ่งอย่างระหว่าง input_task_id หรือ image_urls เท่านั้น หากระบุทั้งสองอย่าง input_task_id จะมีลำดับความสำคัญ

  • Name
    input_task_id
    Type
    string
    จำเป็น
    Description

    ID ของงานสร้างรูปภาพที่เสร็จสมบูรณ์ ซึ่งเอาต์พุต (1-4 รูป) ควรถูกใช้เป็นอินพุต งานนี้ต้องเป็นหนึ่งในงานต่อไปนี้: ข้อความเป็นรูปภาพ, รูปภาพเป็นรูปภาพ, Text to Image มุมมองหลายด้าน หรือ Image to Image มุมมองหลายด้าน นอกจากนี้ ต้องรันผ่าน API และมีสถานะเป็น SUCCEEDED

  • Name
    image_urls
    Type
    array
    จำเป็น
    Description

    ระบุรูปภาพ 1 ถึง 4 รูปให้ Meshy ใช้ในการสร้างโมเดล ขณะนี้เรารองรับรูปแบบ .jpg, .jpeg และ .png รูปภาพทั้งหมดควรแสดงวัตถุเดียวกันจากมุมที่ต่างกันเพื่อผลลัพธ์ที่ดีที่สุด

    มีสองวิธีในการระบุรูปภาพแต่ละรูป:

    • URL ที่เข้าถึงได้แบบสาธารณะ: URL ที่สามารถเข้าถึงได้จากอินเทอร์เน็ตสาธารณะ
    • Data URI: Data URI ของรูปภาพที่เข้ารหัสแบบ base64 ตัวอย่างของ Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • 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) เพิ่มเติมจากสีพื้นฐาน และจะรวม emission map ไว้ด้วยเมื่อ ai_model เป็น meshy-6 หรือ latest

  • 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: Data URI ของรูปภาพที่เข้ารหัสแบบ base64 ตัวอย่างของ Data URI: data:image/jpeg;base64,<your base64-encoded image data>

    การสร้างเท็กซ์เจอร์จากรูปภาพอาจทำงานได้ไม่เหมาะสมหากมีความแตกต่างของจีออเมทรีอย่างมากระหว่าง asset ต้นฉบับกับรูปภาพที่อัปโหลด สามารถใช้ได้เพียงหนึ่งอย่างระหว่าง texture_image_url หรือ texture_prompt เพื่อกำกับกระบวนการสร้างเท็กซ์เจอร์ หากระบุพารามิเตอร์ทั้งสองอย่าง ระบบจะใช้ texture_prompt เพื่อสร้างเท็กซ์เจอร์ให้โมเดลโดยค่าเริ่มต้น

  • 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 เป็นหลัก
    • triangle: สร้างเมชสามเหลี่ยมที่ถูกลดรายละเอียดแล้ว
  • 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

    เมื่อตั้งค่าเป็น 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
    • "" (สตริงว่าง): ไม่ใช้ท่าทางเฉพาะ
  • 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

    ลบไฮไลต์และเงาออกจากเท็กซ์เจอร์สีพื้นฐาน ทำให้ได้ผลลัพธ์ที่สะอาดขึ้นและทำงานได้ดีขึ้นภายใต้การตั้งค่าแสงแบบกำหนดเอง

    รองรับเฉพาะเมื่อ ai_model เป็น meshy-6 หรือ latest เท่านั้น

  • 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 รูป
    • รูปแบบรูปภาพไม่ถูกต้อง: รูปภาพหนึ่งรูปหรือมากกว่าใน image_urls ไม่ใช่รูปแบบที่รองรับ
    • URL เข้าถึงไม่ได้: ไม่สามารถดาวน์โหลด image_urls หนึ่งรายการหรือมากกว่าได้
  • Name
    401 - Unauthorized
    Description

    การยืนยันตัวตนล้มเหลว โปรดตรวจสอบ API คีย์ของคุณ

  • Name
    402 - Payment Required
    Description

    เครดิตไม่เพียงพอสำหรับดำเนินงานนี้

  • Name
    429 - Too Many Requests
    Description

    คุณใช้เกินการจำกัดอัตราของคุณแล้ว

Request

POST
/openapi/v1/multi-image-to-3d
# 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 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>"
    ],
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

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

ดึงข้อมูลงาน หลายรูปเป็น 3D

เอนด์พอยต์นี้ช่วยให้คุณดึงข้อมูลงาน หลายรูปเป็น 3D โดยระบุ id ของงานที่ถูกต้อง ดู ออบเจ็กต์งาน หลายรูปเป็น 3D เพื่อดูว่า มีคุณสมบัติใดบ้างที่รวมอยู่ในออบเจ็กต์งาน หลายรูปเป็น 3D

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ตัวระบุเฉพาะสำหรับงาน หลายรูปเป็น 3D ที่ต้องการดึงข้อมูล

ค่าที่ส่งคืน

การตอบกลับประกอบด้วยออบเจ็กต์งาน หลายรูปเป็น 3D ตรวจสอบ ส่วน ออบเจ็กต์งาน หลายรูปเป็น 3D เพื่อดูรายละเอียด

Request

GET
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
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
}
DELETE/openapi/v1/multi-image-to-3d/:id

ลบงานหลายรูปเป็น 3D

เอนด์พอยต์นี้จะลบงานหลายรูปเป็น 3D อย่างถาวร รวมถึงโมเดลและข้อมูลทั้งหมดที่เกี่ยวข้อง การดำเนินการนี้ไม่สามารถย้อนกลับได้

พารามิเตอร์พาธ

  • Name
    id
    Type
    path
    Description

    ID ของงานหลายรูปเป็น 3D ที่ต้องการลบ

ค่าที่ส่งคืน

ส่งคืน 200 OK เมื่อสำเร็จ

Request

DELETE
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
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

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

แสดงรายการงานหลายรูปเป็น 3D

เอนด์พอยต์นี้ช่วยให้คุณดึงรายการงานหลายรูปเป็น 3D ได้

พารามิเตอร์

แอตทริบิวต์ที่ไม่บังคับ

  • Name
    page_num
    Type
    integer
    Description

    หมายเลขหน้าสำหรับการแบ่งหน้า เริ่มต้นและมีค่าเริ่มต้นเป็น 1

  • Name
    page_size
    Type
    integer
    Description

    ขีดจำกัดขนาดหน้า ค่าเริ่มต้นคือ 10 รายการ จำนวนสูงสุดที่อนุญาตคือ 50 รายการ

  • Name
    sort_by
    Type
    string
    Description

    ฟิลด์ที่จะใช้จัดเรียง ค่าที่ใช้ได้:

    • +created_at: จัดเรียงตามเวลาที่สร้างจากน้อยไปมาก
    • -created_at: จัดเรียงตามเวลาที่สร้างจากมากไปน้อย

ค่าที่ส่งคืน

ส่งคืนรายการแบบแบ่งหน้าของ อ็อบเจกต์งานหลายรูปเป็น 3D

Request

GET
/openapi/v1/multi-image-to-3d
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
  }
]
GET/openapi/v1/multi-image-to-3d/:id/stream

สตรีมงานหลายรูปเป็น 3D

เอนด์พอยต์นี้สตรีมการอัปเดตแบบเรียลไทม์สำหรับงานหลายรูปเป็น 3D โดยใช้ Server-Sent Events (SSE)

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ตัวระบุเฉพาะสำหรับงานหลายรูปเป็น 3D ที่ต้องการสตรีม

ส่งคืน

ส่งคืนสตรีมของ อ็อบเจกต์งานหลายรูปเป็น 3D ในรูปแบบ Server-Sent Events

สำหรับงาน PENDING หรือ IN_PROGRESS สตรีมการตอบกลับจะรวมเฉพาะฟิลด์ progress และ status ที่จำเป็นเท่านั้น

Request

GET
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
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
}

ออบเจ็กต์งานหลายรูปเป็น 3D

ออบเจ็กต์งานหลายรูปเป็น 3D คือหน่วยงานที่ Meshy ติดตามเพื่อสร้างโมเดล 3D จากรูปภาพหลายรูป (ตั้งแต่ 1 ถึง 4 รูป) รูปภาพควรเป็นวัตถุเดียวกัน โดยเหมาะที่สุดคือมาจากมุมมองหรือมุมที่แตกต่างกัน ออบเจ็กต์มีคุณสมบัติดังต่อไปนี้:

คุณสมบัติ

  • Name
    id
    Type
    string
    Description

    ตัวระบุเฉพาะสำหรับงาน แม้ว่าเราจะใช้ UUID แบบ k-sortable สำหรับ id ของงานเป็น รายละเอียดการใช้งานจริง แต่คุณ ไม่ควร ตั้งสมมติฐานใด ๆ เกี่ยวกับรูปแบบของ id

  • Name
    type
    Type
    string
    Description

    ประเภทของงาน หลายรูปเป็น 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 ดั้งเดิมก่อนการรีทอปโลจี

      ใช้ได้เฉพาะเมื่องานถูกสร้างด้วยทั้ง 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
    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 เท็กซ์เจอร์ที่สร้างจากงาน โดยปกติจะมีออบเจ็กต์ URL เท็กซ์เจอร์เพียง หนึ่ง รายการ แต่ละ URL เท็กซ์เจอร์มีคุณสมบัติต่อไปนี้:

    • Name
      base_color
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้ไปยังรูปภาพแมปสีพื้นฐาน

    • Name
      metallic
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้ไปยังรูปภาพแมป metallic

      หากงานถูกสร้างด้วย enable_pbr: false คุณสมบัตินี้จะถูกละไว้

    • Name
      normal
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้ไปยังรูปภาพนอร์มัลแมป

      หากงานถูกสร้างด้วย enable_pbr: false คุณสมบัตินี้จะถูกละไว้

    • Name
      roughness
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้ไปยังรูปภาพแมป roughness

      หากงานถูกสร้างด้วย enable_pbr: false คุณสมบัตินี้จะถูกละไว้

    • Name
      emission
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้ไปยังรูปภาพแมป emission

      หากงานถูกสร้างด้วย 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 ส่งคืน 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,
}