ซ่อมความสามารถในการพิมพ์ API

ซ่อมแซมโมเดล 3D สำหรับความสามารถในการพิมพ์ FDM — แก้ไขขอบ non-manifold, หน้าเสื่อม, รู และปัญหา topology อื่น ๆ เพื่อให้เมชพร้อมสำหรับการพิมพ์


POST/openapi/v1/print/repair

สร้างงานซ่อมความสามารถในการพิมพ์

เอนด์พอยต์นี้สร้างงานซ่อมความสามารถในการพิมพ์ใหม่ งานนี้จะดำเนินการซ่อม topology บนโมเดล 3D และส่งคืนเวอร์ชันที่กันน้ำและพร้อมพิมพ์

รูปแบบเอาต์พุตจะตรงกับรูปแบบอินพุต หากคุณส่ง .stl ผ่าน model_url ค่า model_urls.stl ในการตอบกลับจะเก็บเมชที่ซ่อมแล้ว และฟิลด์รูปแบบอื่นๆ จะว่างเปล่า เส้นทาง input_task_id จะอ่าน GLB ของงานต้นทางเสมอ ดังนั้นเอาต์พุตจึงเป็น .glb

พารามิเตอร์

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

    URL ของโมเดล 3D ที่จะซ่อม รูปแบบที่รองรับ: .glb, .stl, .obj ขนาดไฟล์สูงสุด: 100 MB ต้องใช้ URL แบบ http, https หรือ data: (data URLs จะข้ามการตรวจสอบนามสกุล)

  • Name
    alpha_thumbnail
    Type
    boolean
    ค่าเริ่มต้น false
    Description

    เมื่อตั้งค่าเป็น true งานจะเรนเดอร์เวอร์ชันพื้นหลังโปร่งใส (RGBA) ของตัวอย่างเพิ่มเติม และส่งคืนเป็น alpha_thumbnail_url ในการตอบกลับ GET ฟิลด์ thumbnail_url ที่มีอยู่จะไม่เปลี่ยนแปลง

ผลลัพธ์ที่ส่งกลับ

พร็อพเพอร์ตี result ของการตอบกลับมี id ของงานซ่อมความสามารถในการพิมพ์ที่สร้างขึ้นใหม่

โหมดความล้มเหลว

  • Name
    400 - Bad Request
    Description

    คำขอไม่เป็นที่ยอมรับ สาเหตุที่พบบ่อย:

    • พารามิเตอร์หายไป: ไม่ได้ระบุทั้ง input_task_id และ model_url
    • UUID ไม่ถูกต้อง: input_task_id ไม่ใช่ UUID ที่ถูกต้อง
    • URL โมเดลไม่ถูกต้อง: model_url มีรูปแบบผิด ใช้สคีมาที่ไม่รองรับ หรือมีนามสกุลไฟล์ที่ไม่รองรับ
    • ไฟล์โมเดลใหญ่เกินไป: เนื้อหา model_url เกิน 100 MB
    • งานยังไม่สำเร็จ: งานที่อ้างอิงยังคงรอดำเนินการ อยู่ใน progress หรือล้มเหลว
    • GLB หายไป: งานที่อ้างอิงไม่มีแอสเซต GLB ให้ซ่อม
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    สาเหตุที่พบบ่อย:

    • แพ็กเกจฟรี: การสร้างงานต้องใช้แพ็กเกจแบบชำระเงิน อัปเกรดได้ที่ หน้าการสมัครสมาชิก
    • เครดิตไม่เพียงพอ: ถึงขีดจำกัดเครดิตของพื้นที่ทำงานแล้ว
  • Name
    404 - Not Found
    Description

    งานที่อ้างอิงไม่มีอยู่ หรือเป็นของผู้ใช้อื่น

  • Name
    429 - Too Many Requests
    Description

    คุณเกินโควต้างานที่รอดำเนินการหรือการจำกัดอัตราแล้ว

Request

POST
/openapi/v1/print/repair
# Repair an existing task
curl https://api.meshy.ai/openapi/v1/print/repair \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

# Or repair a model URL directly
curl https://api.meshy.ai/openapi/v1/print/repair \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.stl"
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/print/repair/:id

ดึงข้อมูลงานซ่อมความสามารถในการพิมพ์

เอนด์พอยต์นี้ดึงข้อมูลงานซ่อมความสามารถในการพิมพ์ตาม ID ของงาน

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ID ของงานซ่อมความสามารถในการพิมพ์ที่จะดึงข้อมูล

ส่งคืน

อ็อบเจ็กต์งานซ่อมความสามารถในการพิมพ์ บล็อก model_urls จะว่างเปล่าจนกว่างานจะถึงสถานะ SUCCEEDED ระบบจะเติมข้อมูลเฉพาะฟิลด์ model_urls ที่ตรงกับรูปแบบอินพุตเท่านั้น

Request

GET
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl https://api.meshy.ai/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "",
    "fbx": "",
    "obj": "",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}

DELETE/openapi/v1/print/repair/:id

ลบงานซ่อมความสามารถในการพิมพ์

เอนด์พอยต์นี้จะลบงานซ่อมความสามารถในการพิมพ์และเอาต์พุตที่ซ่อมแล้วของงานนั้นอย่างถาวร การดำเนินการนี้ไม่สามารถย้อนกลับได้

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

  • Name
    id
    Type
    path
    Description

    ID ของงานซ่อมความสามารถในการพิมพ์ที่จะลบ

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

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

Request

DELETE
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/print/repair

แสดงรายการงานซ่อมความสามารถในการพิมพ์

เอนด์พอยต์นี้ช่วยให้คุณดึงรายการงานซ่อมความสามารถในการพิมพ์ได้

พารามิเตอร์

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

  • 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: จัดเรียงตามเวลาที่สร้างจากมากไปน้อย

ส่งคืน

ส่งคืนรายการแบบแบ่งหน้าของ อ็อบเจ็กต์งานซ่อมความสามารถในการพิมพ์

Request

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-repair",
    "status": "SUCCEEDED",
    "progress": 100,
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000030000,
    "expires_at": 1715725401000,
    "task_error": null,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "",
      "obj": "",
      "stl": "",
      "usdz": "",
      "3mf": "",
      "mtl": ""
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
    "texture_urls": [],
    "consumed_credits": 10
  }
]

GET/openapi/v1/print/repair/:id/stream

สตรีมงานซ่อมความสามารถในการพิมพ์

เอนด์พอยต์นี้สตรีมการอัปเดตแบบเรียลไทม์สำหรับงานซ่อมความสามารถในการพิมพ์โดยใช้ Server-Sent Events (SSE)

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ตัวระบุเฉพาะสำหรับงานซ่อมความสามารถในการพิมพ์ที่จะสตรีม

ส่งคืน

ส่งคืนสตรีมของ ออบเจ็กต์งานซ่อมความสามารถในการพิมพ์ ในรูปแบบ Server-Sent Events

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

Request

GET
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f/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": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***",
    "fbx": "",
    "obj": "",
    "stl": "",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}

อ็อบเจกต์งานซ่อมความสามารถในการพิมพ์

  • Name
    id
    Type
    string
    Description

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

  • Name
    type
    Type
    string
    Description

    ประเภทของงานซ่อมความสามารถในการพิมพ์ ค่าคือ print-repair

  • Name
    status
    Type
    string
    Description

    สถานะของงาน ค่าที่เป็นไปได้คือค่าใดค่าหนึ่งใน PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED

  • Name
    progress
    Type
    integer
    Description

    progress ของงาน หากงานยังไม่เริ่ม คุณสมบัตินี้จะเป็น 0 เมื่องานสำเร็จแล้ว ค่านี้จะกลายเป็น 100

  • Name
    preceding_tasks
    Type
    integer
    Description

    จำนวนของงานก่อนหน้า

  • 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

    ไทม์สแตมป์ของเวลาที่ผลลัพธ์ของงานจะหมดอายุจากระบบ หน่วยเป็นมิลลิวินาที เป็น 0 หากงานยังไม่เสร็จสิ้น

  • Name
    task_error
    Type
    object
    Description

    ข้อมูลข้อผิดพลาดหากงานล้มเหลว คุณสมบัตินี้จะเป็น null หากงานไม่ล้มเหลว ดู ข้อผิดพลาด สำหรับรายละเอียดเพิ่มเติม

    • Name
      message
      Type
      string
      Description

      ข้อความข้อผิดพลาดที่อธิบายว่าเกิดอะไรผิดพลาด

  • Name
    model_urls
    Type
    object
    Description

    URL ที่ดาวน์โหลดได้สำหรับโมเดล 3D ที่ซ่อมแล้ว จะมีข้อมูลเฉพาะฟิลด์ที่ตรงกับรูปแบบอินพุตเท่านั้น; ฟิลด์รูปแบบอื่นจะเป็นสตริงว่าง

    • Name
      glb
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้สำหรับ GLB ที่ซ่อมแล้ว จะมีข้อมูลเมื่ออินพุตเป็น GLB หรือเมื่อใช้ input_task_id

    • Name
      fbx
      Type
      string
      Description

      สงวนไว้สำหรับเอาต์พุต FBX เป็นสตริงว่างเสมอสำหรับงานซ่อมความสามารถในการพิมพ์

    • Name
      obj
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้สำหรับ OBJ ที่ซ่อมแล้ว จะมีข้อมูลเมื่ออินพุตเป็นการอัปโหลด OBJ

    • Name
      stl
      Type
      string
      Description

      URL ที่ดาวน์โหลดได้สำหรับ STL ที่ซ่อมแล้ว จะมีข้อมูลเมื่ออินพุตเป็นการอัปโหลด STL

    • Name
      usdz
      Type
      string
      Description

      สงวนไว้สำหรับเอาต์พุต USDZ เป็นสตริงว่างเสมอสำหรับงานซ่อมความสามารถในการพิมพ์

    • Name
      3mf
      Type
      string
      Description

      สงวนไว้สำหรับเอาต์พุต 3MF เป็นสตริงว่างเสมอสำหรับงานซ่อมความสามารถในการพิมพ์

    • Name
      mtl
      Type
      string
      Description

      สงวนไว้สำหรับเอาต์พุต MTL เป็นสตริงว่างเสมอสำหรับงานซ่อมความสามารถในการพิมพ์

  • Name
    thumbnail_url
    Type
    string
    Description

    URL ของภาพตัวอย่างที่เรนเดอร์จากโมเดลที่ซ่อมแล้ว

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL ที่ดาวน์โหลดได้สำหรับเวอร์ชันพื้นหลังโปร่งใส (RGBA) ของ thumbnail_url มีเฉพาะเมื่องานถูกสร้างด้วย alpha_thumbnail: true และเรนเดอร์ตัวอย่างแบบโปร่งใสสำเร็จแล้ว มิฉะนั้นฟิลด์นี้จะถูกละไว้

  • Name
    texture_urls
    Type
    array
    Description

    เป็นอาร์เรย์ว่างเสมอ การซ่อมจะคงไว้เฉพาะจีออเมทรีของอินพุตและไม่อบเท็กซ์เจอร์ใหม่

  • Name
    consumed_credits
    Type
    integer
    Description

    จำนวนเครดิตที่งานนี้ใช้ไป เป็น 10 เมื่องานถึงสถานะ SUCCEEDED แล้ว ส่งคืน 0 สำหรับงาน FAILED (เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)

The Repair Printability Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "fbx": "",
    "obj": "",
    "stl": "",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}