รีเมช API

รีเมช API ช่วยให้คุณรีเมชและส่งออกโมเดล 3D ที่มีอยู่ซึ่งสร้างโดย API อื่น ๆ ของ Meshy (เช่น รูปภาพเป็น 3D หรือ ข้อความเป็น 3D) เป็นรูปแบบต่าง ๆ ได้ ส่วนนี้ให้รายละเอียดเกี่ยวกับวิธีใช้รีเมช API

POST/openapi/v1/remesh

สร้างงานรีเมช

เอนด์พอยต์นี้สร้างงานรีเมชใหม่

สำหรับการแปลงรูปแบบและการปรับขนาด ให้ใช้ Convert API และ Resize API ที่ออกแบบมาเฉพาะ พารามิเตอร์ที่เลิกใช้ด้านล่างจะยังคงใช้งานได้ แต่เราแนะนำให้ใช้เอนด์พอยต์ใหม่สำหรับการผสานระบบใหม่

พารามิเตอร์

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

Name
input_task_id
Type
string
จำเป็น
Description
ID ของงาน รูปภาพเป็น 3D หรือ ข้อความเป็น 3D ที่เสร็จสมบูรณ์แล้ว ซึ่งคุณต้องการรีเมช งานนี้ต้องเป็นหนึ่งในงานต่อไปนี้: Text to 3D Preview, Text to 3D Refine, รูปภาพเป็น 3D หรือ รีเท็กซ์เจอร์ นอกจากนี้ งานต้องมีสถานะเป็น SUCCEEDED

Name
model_url
Type
string
จำเป็น
Description
โปรดระบุโมเดล 3D ให้ Meshy รีเมชผ่าน URL ที่เข้าถึงได้แบบสาธารณะหรือ Data URI รูปแบบที่รองรับ: .glb, .gltf, .obj, .fbx, .stl
สำหรับ Data URI ให้ใช้ MIME type: application/octet-stream

Name
target_formats
Type
string[]
ค่าเริ่มต้น ["glb"]
Description
รายการรูปแบบเป้าหมายสำหรับโมเดลที่รีเมชแล้ว หากละไว้ จะสร้างเฉพาะ GLB เท่านั้น
ค่าที่ใช้ได้: glb, fbx, obj, usdz, blend, stl, 3mf
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
resize_height
Type
number
⚠ เลิกใช้แล้ว
ค่าเริ่มต้น 0
Description
ปรับขนาดโมเดลให้มีความสูงตามที่กำหนด โดยวัดเป็นเมตร เราแนะนำให้ใช้ Resize API ที่ออกแบบมาเฉพาะแทน
auto_size, resize_height และ resize_longest_side ไม่สามารถใช้ร่วมกันได้
Name
resize_longest_side
Type
number
⚠ เลิกใช้แล้ว
ค่าเริ่มต้น 0
Description
ปรับขนาดโมเดลเพื่อให้มิติของ bounding-box ด้านที่ยาวที่สุดเท่ากับค่าที่ระบุเป็นเมตร เราแนะนำให้ใช้ Resize API ที่ออกแบบมาเฉพาะแทน
auto_size, resize_height และ resize_longest_side ไม่สามารถใช้ร่วมกันได้
Name
auto_size
Type
boolean
⚠ เลิกใช้แล้ว
ค่าเริ่มต้น false
Description
เมื่อตั้งค่าเป็น true บริการจะใช้ AI vision เพื่อประมาณความสูงจริงของวัตถุโดยอัตโนมัติ และปรับขนาดโมเดลตามนั้น เราแนะนำให้ใช้ Resize API ที่ออกแบบมาเฉพาะแทน
auto_size, resize_height และ resize_longest_side ไม่สามารถใช้ร่วมกันได้

ใช้เฉพาะเมื่อ auto_size = true

Name
origin_at
Type
string
⚠ เลิกใช้แล้ว
ค่าเริ่มต้น bottom
Description
ตำแหน่งของจุดกำเนิด เราแนะนำให้ใช้ Resize API ที่ออกแบบมาเฉพาะแทน
ค่าที่ใช้ได้: bottom, center

Name
convert_format_only
Type
boolean
⚠ เลิกใช้แล้ว
Description
หากเป็น true บริการจะเปลี่ยนเฉพาะรูปแบบของไฟล์โมเดลอินพุต โดยละเว้นอินพุตอื่น ๆ เช่น topology, resize_height และ target_polycount เราแนะนำให้ใช้ Convert API ที่ออกแบบมาเฉพาะแทน
ต้องระบุ target_formats หากตั้งค่า convert_format_only เป็น true

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

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

คุณสมบัติ result ของการตอบกลับมี id ของงานรีเมชที่สร้างขึ้นใหม่

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

Name
400 - Bad Request
Description
คำขอไม่สามารถยอมรับได้ สาเหตุทั่วไป:
- พารามิเตอร์หายไป: ต้องระบุ model_url หรือ input_task_id
- งานอินพุตไม่ถูกต้อง: input_task_id ต้องอ้างอิงถึงงานที่สำเร็จจากโมเดลที่รองรับ
- รูปแบบโมเดลไม่ถูกต้อง: model_url ชี้ไปยังไฟล์ที่มีนามสกุลไม่รองรับ
- URL เข้าถึงไม่ได้: ไม่สามารถดาวน์โหลด model_url ได้
- topology ไม่ถูกต้อง: พารามิเตอร์ topology ไม่ถูกต้อง
- พารามิเตอร์ที่ใช้ร่วมกันไม่ได้: ไม่สามารถตั้งค่า auto_size และ resize_height พร้อมกันได้
Name
401 - Unauthorized
Description
การยืนยันตัวตนล้มเหลว โปรดตรวจสอบ API คีย์ของคุณ
Name
402 - Payment Required
Description
เครดิตไม่เพียงพอที่จะดำเนินงานนี้
Name
429 - Too Many Requests
Description
คุณใช้เกินการจำกัดอัตราของคุณแล้ว

Request

POST

/openapi/v1/remesh

# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "resize_height": 1.0,
    "origin_at": "bottom"
  }'

# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "auto_size": true
  }'

Response

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

GET/openapi/v1/remesh/:id

ดึงข้อมูลงานรีเมช

เอนด์พอยต์นี้ดึงข้อมูลงานรีเมชตาม ID ของงาน

พารามิเตอร์

Name
id
Type
path
Description
ID ของงานรีเมชที่ต้องการดึงข้อมูล

ส่งคืน

ออบเจ็กต์งานรีเมช

Request

GET

/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

DELETE/openapi/v1/remesh/:id

ลบงานรีเมช

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

พารามิเตอร์เส้นทาง

Name
id
Type
path
Description
ID ของงานรีเมชที่ต้องการลบ

ส่งคืน

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

Request

DELETE

/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/remesh

แสดงรายการงานรีเมช

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

พารามิเตอร์

Name
page_num
Type
integer
ค่าเริ่มต้น 1
Description
หมายเลขหน้าสำหรับการแบ่งหน้า
Name
page_size
Type
integer
ค่าเริ่มต้น 10
Description
ขีดจำกัดขนาดหน้า จำนวนสูงสุดที่อนุญาตคือ 50 รายการ
Name
sort_by
Type
string
Description
ฟิลด์ที่จะใช้เรียงลำดับ
ค่าที่ใช้ได้:
- +created_at: เรียงตามเวลาที่สร้างจากน้อยไปมาก
- -created_at: เรียงตามเวลาที่สร้างจากมากไปน้อย

ส่งคืน

ส่งคืนรายการแบบแบ่งหน้าของ อ็อบเจ็กต์งานรีเมช

Request

GET

/openapi/v1/remesh

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "remesh",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null
  }
]

GET/openapi/v1/remesh/:id/stream

สตรีมงานรีเมช

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

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุที่ไม่ซ้ำกันสำหรับงานรีเมชที่จะสตรีม

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

ส่งคืนสตรีมของ ออบเจกต์งานรีเมช ในรูปแบบ Server-Sent Events

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

Request

GET

/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream

curl -N https://api.meshy.ai/openapi/v1/remesh/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": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
    "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
}

ออบเจ็กต์งานรีเมช

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

คุณสมบัติ

Name
id
Type
string
Description
ตัวระบุที่ไม่ซ้ำกันสำหรับงาน แม้ว่าเราจะใช้ UUID แบบ k-sortable สำหรับ id ของงานเป็น รายละเอียดการใช้งาน คุณไม่ควรตั้งสมมติฐานใดๆ เกี่ยวกับรูปแบบของ id
Name
type
Type
string
Description
ประเภทของงานรีเมช ค่าคือ remesh
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
  blend
  Type
  string
  Description
  URL ที่ดาวน์โหลดได้ไปยังไฟล์ Blender
- Name
  stl
  Type
  string
  Description
  URL ที่ดาวน์โหลดได้ไปยังไฟล์ STL
- Name
  3mf
  Type
  string
  Description
  URL ที่ดาวน์โหลดได้ไปยังไฟล์ 3MF มีอยู่เฉพาะเมื่อมีการร้องขอ 3mf ผ่าน target_formats
Name
thumbnail_url
Type
string
Description
URL ที่ดาวน์โหลดได้ไปยังรูปภาพตัวอย่างที่เรนเดอร์จากโมเดลที่ถูกรีเมช
Name
alpha_thumbnail_url
Type
string
Description
URL ที่ดาวน์โหลดได้ไปยังเวอร์ชันพื้นหลังโปร่งใส (RGBA) ของ thumbnail_url มีอยู่เฉพาะเมื่องานถูกสร้างด้วย alpha_thumbnail: true และตัวอย่างแบบโปร่งใสถูกเรนเดอร์สำเร็จ มิฉะนั้นฟิลด์นี้จะถูกละไว้
Name
progress
Type
integer
Description
progress ของงาน หากงานยังไม่เริ่มต้น คุณสมบัตินี้จะเป็น 0 เมื่องานสำเร็จแล้ว ค่านี้จะกลายเป็น 100
Name
status
Type
string
Description
สถานะของงาน ค่าที่เป็นไปได้คือหนึ่งใน PENDING, IN_PROGRESS, SUCCEEDED, FAILED
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
task_error
Type
object
Description
รายละเอียดข้อผิดพลาดสำหรับงานที่ล้มเหลว ดู ข้อผิดพลาด สำหรับเอกสารอ้างอิงออบเจ็กต์ task_error ฉบับเต็ม
Name
consumed_credits
Type
integer
Description
จำนวนเครดิตที่งานนี้ใช้ มีอยู่เมื่อสถานะงานเป็น PENDING, IN_PROGRESS หรือ SUCCEEDED ส่งคืน 0 สำหรับงาน FAILED (เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)

Example Remesh Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "remesh",
  "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
      "blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
      "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5
}