API ปรับขนาด

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

POST/openapi/v1/resize

สร้างงานปรับขนาด

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

พารามิเตอร์

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

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

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

จำเป็นต้องมี mode การปรับขนาดเพียงหนึ่งอย่าง: resize_height, resize_longest_side หรือ auto_size พารามิเตอร์ทั้งสามนี้ไม่สามารถใช้ร่วมกันได้

Name
resize_height
Type
number
Description
ปรับขนาดโมเดลให้มีความสูงเฉพาะที่วัดเป็นเมตร

Name
resize_longest_side
Type
number
Description
ปรับขนาดโมเดลให้ด้านที่ยาวที่สุดตรงกับค่านี้ โดยวัดเป็นเมตร อัตราส่วนภาพจะถูกคงไว้

Name
auto_size
Type
boolean
Description
เมื่อตั้งค่าเป็น true บริการจะใช้ AI vision เพื่อประมาณความสูงจริงของวัตถุโดยอัตโนมัติ และปรับขนาดโมเดลตามนั้น จุดกำเนิดจะมีค่าเริ่มต้นเป็น bottom เว้นแต่จะตั้งค่า origin_at ไว้อย่างชัดเจน

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

ส่งคืน

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

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

400 - Bad Request

คำขอไม่สามารถยอมรับได้ สาเหตุที่พบบ่อย:

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

401 - Unauthorized

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

402 - Payment Required

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

429 - Too Many Requests

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

Request

POST

/openapi/v1/resize

# Simple: resize to a specific height
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "resize_height": 1.8
  }'

# Advanced: resize longest side with custom origin
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.glb",
    "resize_longest_side": 2.0,
    "origin_at": "center"
  }'

Response

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

GET/openapi/v1/resize/:id

เรียกดูงานปรับขนาด

เอนด์พอยต์นี้เรียกดูงานปรับขนาดตาม ID ของงาน

พารามิเตอร์

Name
id
Type
path
Description
ID ของงานปรับขนาดที่ต้องการเรียกดู

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

อ็อบเจ็กต์งานปรับขนาด

Request

GET

/openapi/v1/resize/:id

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

Response

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

DELETE/openapi/v1/resize/:id

ลบงานปรับขนาด

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

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

Name
id
Type
path
Description
ID ของงานปรับขนาดที่จะลบ

การส่งคืน

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

Request

DELETE

/openapi/v1/resize/:id

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/resize

แสดงรายการงานปรับขนาด

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

พารามิเตอร์

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

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

Response

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

GET/openapi/v1/resize/:id/stream

สตรีมงานปรับขนาด

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

พารามิเตอร์

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

ส่งคืน

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

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

Request

GET

/openapi/v1/resize/:id/stream

curl -N https://api.meshy.ai/openapi/v1/resize/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": "resize",
  "model_urls": {
    "glb": "https://assets.meshy.ai/.../model.glb?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

อ็อบเจ็กต์งานปรับขนาด

อ็อบเจ็กต์งานปรับขนาดแสดงถึงงานปรับขนาด

คุณสมบัติ

id · สตริง

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

type · สตริง

ประเภทของงาน ค่าคือ resize

model_urls · ออบเจ็กต์

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

progress · จำนวนเต็ม

progress ของงาน (0-100)

status · สตริง

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

preceding_tasks · จำนวนเต็ม

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

created_at · ไทม์สแตมป์

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

started_at · ไทม์สแตมป์

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

finished_at · ไทม์สแตมป์

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

task_error · ออบเจ็กต์

ออบเจ็กต์ข้อผิดพลาดหากงานล้มเหลว ดูรายละเอียดเพิ่มเติมที่ ข้อผิดพลาด

consumed_credits · จำนวนเต็ม

จำนวนเครดิตที่งานนี้ใช้ไป (1 เครดิตต่อหนึ่งงานปรับขนาด) ส่งคืน 0 สำหรับงาน FAILED