尺寸調整 API

尺寸調整 API 可讓您將現有 3D 模型縮放至真實世界的尺寸。您可以指定精確高度、最長邊限制，或讓 AI 自動估算合適的尺寸。

POST/openapi/v1/resize

建立尺寸調整任務

此端點用於建立新的尺寸調整任務。

參數

只需提供 input_task_id 或 model_url 其中之一（必選）。如果兩者都提供，會優先使用 input_task_id。

Name
input_task_id
Type
string
必选
Description
需要調整尺寸的已完成 Meshy 任務 ID。該任務必須具有 SUCCEEDED 狀態。輸出格式為 GLB。

Name
model_url
Type
string
必选
Description
可公開存取的 URL 或 Data URI，指向一個 3D 模型檔案。支援的格式：.glb、.gltf、.obj、.fbx、.stl。對於 Data URI，請使用 MIME 類型：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 視覺自動估算物件的實際高度，並相應調整模型大小。除非明確設定了 origin_at，否則原點將預設為 bottom。

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

您已超出請求頻率限制。

请求

POST

/openapi/v1/resize

# 简单示例：指定高度
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
  }'

# 进阶示例：指定最长边并设置原点
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"
  }'

响应

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

GET/openapi/v1/resize/:id

取得尺寸調整任務

此端點用於透過 ID 取得尺寸調整任務。

參數

Name
id
Type
path
Description
要取得的尺寸調整任務 ID。

回傳值

回傳尺寸調整任務物件。

请求

GET

/openapi/v1/resize/:id

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

响应

{
  "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。

请求

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}"

响应

// 成功则返回 200 Ok。

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：依建立時間遞減排序。

回傳值

回傳分頁的尺寸調整任務物件清單。

请求

GET

/openapi/v1/resize

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

响应

[
  {
    "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
要以串流方式取得的尺寸調整任務 ID。

回傳值

回傳尺寸調整任務物件的串流 Server-Sent Events。

對於狀態為 PENDING 或 IN_PROGRESS 的任務，回應串流僅包含必要的 progress 與 status 欄位。

请求

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}"

响应流

// 消息事件示例展示任务进度。
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 · 時間戳

任務建立時的時間戳，以毫秒為單位。

started_at · 時間戳

任務開始時的時間戳，以毫秒為單位。尚未開始時為 0。

finished_at · 時間戳

任務完成時的時間戳，以毫秒為單位。尚未完成時為 0。

task_error · object

任務失敗時的錯誤物件。詳細資訊請參閱錯誤。

consumed_credits · integer

此任務消耗的積分數（每個尺寸調整任務消耗 1 個積分）。FAILED 任務會傳回 0。