Resize API

Resize 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 URIs ให้ใช้ MIME type: application/octet-stream รูปแบบผลลัพธ์จะรักษารูปแบบดั้งเดิมของโมเดลอินพุต

ต้องการโหมดปรับขนาดเพียงหนึ่งโหมด: 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
โหมดปรับขนาดที่ขาดหายไป: ต้องระบุอย่างน้อยหนึ่งใน 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 · string

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

type · string

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

model_urls · object

URL สำหรับดาวน์โหลดไฟล์โมเดลที่ปรับขนาดแล้ว เมื่อใช้ input_task_id ผลลัพธ์จะเป็น GLB เสมอ เมื่อใช้ model_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