แปลง API

แปลง API ช่วยให้คุณแปลงโมเดล 3D ที่มีอยู่ให้เป็นรูปแบบไฟล์ต่างๆ ได้

POST/openapi/v1/convert

สร้างงานแปลงรูปแบบ

เอนด์พอยต์นี้สร้างงานแปลงรูปแบบใหม่

พารามิเตอร์

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

Name
input_task_id
Type
string
จำเป็น
Description
ID ของงาน Meshy ที่เสร็จสมบูรณ์แล้วซึ่งคุณต้องการแปลง งานต้องมีสถานะเป็น SUCCEEDED

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

Name
target_formats
Type
string[]
จำเป็น
Description
รายการรูปแบบเอาท์พุตสำหรับโมเดลที่แปลงแล้ว ค่าที่ใช้ได้: glb, fbx, obj, usdz, blend, stl, 3mf

การส่งคืน

คุณสมบัติ result ของการตอบสนองประกอบด้วย id ของงานแปลงที่สร้างขึ้นใหม่

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

400 - Bad Request

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

พารามิเตอร์ที่ขาดหายไป: ต้องให้ model_url หรือ input_task_id
target_formats ที่ขาดหายไป: ต้องระบุรูปแบบเป้าหมายอย่างน้อยหนึ่งรูปแบบ
งานนำเข้าที่ไม่ถูกต้อง: input_task_id ต้องอ้างอิงถึงงานที่สำเร็จ
รูปแบบโมเดลที่ไม่ถูกต้อง: model_url ชี้ไปยังไฟล์ที่มีนามสกุลที่ไม่รองรับ
URL ที่ไม่สามารถเข้าถึงได้: ไม่สามารถดาวน์โหลด model_url

401 - Unauthorized

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

402 - Payment Required

เครดิตไม่เพียงพอในการดำเนินการนี้

429 - Too Many Requests

คุณได้เกินการจำกัดอัตราของคุณ

Request

POST

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

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

GET/openapi/v1/convert/:id

ดึงข้อมูลงานแปลง

เอนด์พอยต์นี้ใช้ดึงข้อมูลงานแปลงโดยใช้ ID ของมัน

พารามิเตอร์

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

ผลลัพธ์ที่ได้

วัตถุงานแปลง

Request

GET

/openapi/v1/convert/:id

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

Response

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

DELETE/openapi/v1/convert/:id

ลบงานแปลง

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

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

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

ผลลัพธ์

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

Request

DELETE

/openapi/v1/convert/:id

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/convert

รายการงานแปลง

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

พารามิเตอร์

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/convert

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "convert",
    "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]

GET/openapi/v1/convert/:id/stream

สตรีมงานแปลง

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

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุเฉพาะสำหรับงานแปลงที่จะสตรีม

การส่งคืน

ส่งคืนสตรีมของ The Convert Task Objects เป็น Server-Sent Events

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

Request

GET

/openapi/v1/convert/:id/stream

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

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

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

The Convert Task Object

วัตถุ Convert Task แทนงานการแปลงรูปแบบไฟล์

Properties

id · string

ตัวระบุเฉพาะสำหรับงาน

type · string

ประเภทของงาน ค่าเป็น convert

model_urls · object

URL สำหรับดาวน์โหลดไฟล์โมเดลที่แปลงแล้ว เฉพาะรูปแบบที่ระบุใน target_formats เท่านั้นที่จะมี URL คุณสมบัติรูปแบบอื่น ๆ จะเป็นสตริงว่าง

progress · integer

ความคืบหน้าของงาน (0-100)

status · string

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

preceding_tasks · integer

จำนวนงานที่มาก่อน มีความหมายเฉพาะเมื่อสถานะเป็น PENDING

created_at · timestamp

ไทม์สแตมป์เมื่อสร้างงานในหน่วยมิลลิวินาที

started_at · timestamp

ไทม์สแตมป์เมื่อเริ่มงานในหน่วยมิลลิวินาที 0 หากยังไม่ได้เริ่ม

finished_at · timestamp

ไทม์สแตมป์เมื่อสิ้นสุดงานในหน่วยมิลลิวินาที 0 หากยังไม่สิ้นสุด

task_error · object

วัตถุข้อผิดพลาดหากงานล้มเหลว ดู ข้อผิดพลาด สำหรับรายละเอียดเพิ่มเติม

consumed_credits · integer

จำนวนเครดิตที่ใช้โดยงานนี้ (1 เครดิตต่อการแปลงงาน) คืนค่า 0 สำหรับงานที่ FAILED