多色列印 API

將 3D 模型進行格式轉換，產生可用於 3D 列印的多色 3MF 檔案。選擇最多 16 種顏色的調色盤，以及適用於您印表機品牌的切片軟體預設。

POST/openapi/v1/print/multi-color

創建 Multi-Color Print 任務

創建一個 Multi-Color Print 任務，將 3D 模型轉換為用於 3D 列印的多色 3MF 檔案。該任務在後台執行。有關任務通常需要多長時間，請參閱處理時間。

Request

POST

/openapi/v1/print/multi-color

# Convert a 3D model to a multi-color 3MF with a Creality slicer preset
curl https://api.meshy.ai/openapi/v1/print/multi-color \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "max_colors": 8,
    "printer_brand": "creality"
  }'

Response

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

參數

Name
input_task_id
Type
string
必選
Description
除非你傳送 model_url，否則此參數為必填項。你想列印其模型的任務 ID，例如 Image to 3D、Multi-Image to 3D、Text to 3D、Remesh 或 Retexture 任務。該任務必須是你透過 API 創建的任務，且狀態為 SUCCEEDED。
Multi-Color Print 會讀取該任務的 GLB 檔案，其面數最多為 8,000,000。面數超出的模型將回傳 400。此時請先對其執行 Remesh 任務，然後改為傳送該 Remesh 任務的 ID。

Name
model_url
Type
string
必選
Description
除非你傳送 input_task_id，否則此參數為必填項。要列印的模型，可以是公開 URL 或 data URI。如果兩者都傳送，Meshy 會使用 input_task_id。
http 或 https URL 必須指向大小不超過 400 MB 的 .glb 或 .fbx 檔案。data URI 必須是不超過 100 MB 的 base64 編碼 GLB 檔案，需使用 data:model/gltf-binary;base64,。.fbx 檔案須以 http 或 https URL 形式傳送。
超過 100 MB 的檔案還必須遵循以下規則：
- 面數最多為 8,000,000。Meshy 按三角形計算面數，因此一個四邊形計為 2 個面，被多次繪製的 mesh 每份副本都會計入一次。
- FBX 檔案必須是 7.1 或更高版本的二進位 FBX。
- GLB 檔案不得使用 Draco 壓縮。

Name
max_colors
Type
integer
預設值 4
Description
輸出調色盤中的最大顏色數，範圍為 1 到 16。若要使用預設值，請省略該參數，而不是傳送 0。
Name
style
Type
string
預設值 realistic
Description
3MF 檔案的顏色風格。
可用取值：
- realistic：直接從模型的 texture 中取樣顏色，以獲得精細的照片級真實細節，生成的檔案較大。
- cartoon：將顏色扁平化為簡潔、均勻的區域，呈現風格化外觀，生成的檔案較小。
模型必須具有顏色。realistic 需要每個 mesh 部件都帶有 UV 的單一基礎顏色 texture，cartoon 也接受頂點顏色。Meshy 會拒絕沒有 texture（純白色）的模型。參見 model_missing_texture。
Name
max_depth
Type
integer
預設值 4
Description
Meshy 用於將 texture 顏色取樣到 mesh 上的細分深度，範圍為 3 到 6。0 等同於省略該參數。值越大，捕捉的顏色細節越精細，生成的檔案也越大。僅 realistic 風格使用此參數，cartoon 會忽略它。
Name
printer_brand
Type
string
預設值 bambu
Description
Meshy 寫入 3MF 檔案中的 slicer 預設所對應的印表機品牌。該檔案隨後會在該品牌的 slicer 中開啟，並帶有相符的印表機、耗材和工藝設定檔。預設使用該品牌的預設印表機，噴嘴為 0.4 mm。
可用取值：
- bambu
- anycubic
- creality
- elegoo
- flashforge
- prusa
- qidi
- snapmaker
- ankermake
任何其他值都會回傳 400。

回傳值

回應的 result 欄位保存新創建的 Multi-Color Print 任務的 ID。

失敗情形

Name
400 - Bad Request
Description
請求無法執行。錯誤訊息會說明發現的問題。例如：
- 缺少參數：既沒有傳送 model_url，也沒有傳送 input_task_id。
- 模型格式無效：model_url 檔案不是 .glb 或 .fbx 檔案。
- URL 不可存取：Meshy 無法下載 model_url 檔案。
- 模型檔案過大：model_url 檔案以 http 或 https URL 形式提供時超過 400 MB，或以 data URI 形式提供時超過 100 MB。
- 面數過多：model_url 檔案超過 100 MB，且面數超過 8,000,000。請減少面數後重新傳送該檔案。
- ASCII FBX 超過 100 MB：model_url 檔案是超過 100 MB 的 ASCII FBX。請將其作為二進位 FBX 或 GLB 傳送。
- 模型檔案不可讀：model_url 檔案超過 100 MB，且 Meshy 無法讀取其檔頭。例如，它是經過 Draco 壓縮的 GLB，或是早於 7.1 版本的二進位 FBX。
- 模型檔案頭過於複雜：model_url 檔案超過 100 MB，且其檔頭中包含過多需要檢查的 mesh、節點或記錄。請減少檔案中的物件數量後重新傳送。
- 輸入任務無效：input_task_id 不是一個成功的任務。
- 輸入任務中的面數過多：input_task_id 對應的模型面數超過 8,000,000。請先對其執行 Remesh 任務，然後改為傳送該 Remesh 任務的 ID。
- max_colors 無效：max_colors 為負數或超過 16。
- style 無效：style 不是 realistic 或 cartoon。
- max_depth 無效：max_depth 不在 3 到 6 範圍內，且不是 0。
- printer_brand 無效：printer_brand 不是可用取值之一。
- 缺少顏色來源：模型缺少 style 所需的顏色。realistic 需要每個 mesh 部件都帶有 UV 的單一基礎顏色 texture。cartoon 接受基礎顏色 texture 或頂點顏色。請先為模型新增 texture，或者對帶有頂點顏色的模型使用 cartoon。Meshy 僅在任務對 .fbx 上傳檔案完成規範化後才進行檢查，因此該任務會改為以 model_missing_texture 失敗。
請修正請求後重新傳送。參見錯誤。
Name
401 - Unauthorized
Description
API 金鑰缺失或無效。請檢查 Authorization 請求頭。
Name
402 - Payment Required
Description
例如：
- 積分不足：帳戶沒有足夠的積分來執行此任務，或帳戶達到了積分限額。請檢查你的積分餘額，然後重試。
- 免費方案：創建任務需要付費方案。請在你的訂閱設定中升級你的方案，然後重試。
Name
403 - Forbidden
Description
input_task_id 是一個浮雕模型，此端點無法列印此類模型。錯誤訊息為 This model type does not support this operation。請傳送其他模型。
Name
404 - Not Found
Description
input_task_id 與你的任何任務都不相符。請檢查任務 ID，然後重新傳送請求。
Name
429 - Too Many Requests
Description
你超出了速率限制。請稍候後重試。參見速率限制。

GET/openapi/v1/print/multi-color/:id

取得多色列印任務

根據 ID 回傳一個多色列印任務。

Request

GET

/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-multi-color",
  "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1700259201000,
  "task_error": null,
"consumed_credits": 10
}

參數

Name
id
Type
path
Description
建立回應中回傳的任務 ID。

回傳

多色列印任務物件。

DELETE/openapi/v1/print/multi-color/:id

刪除多色列印任務

永久刪除一個多色列印任務，包括其模型和資料。刪除操作無法復原。

Request

DELETE

/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

路徑參數

Name
id
Type
path
Description
要刪除的任務的 ID。

任務狀態

刪除處於 PENDING 狀態的任務會退還你建立該任務時所使用的積分。

處於 IN_PROGRESS 狀態的任務無法刪除。該請求會回傳 409 Conflict，任務會繼續執行。Meshy 不會為已經開始的任務退款，因此刪除它會讓你同時失去積分和結果。請等待任務變為 SUCCEEDED、FAILED 或 CANCELED 狀態後再刪除。

刪除處於最終狀態（SUCCEEDED、FAILED 或 CANCELED）的任務不會退還其積分。

回傳

任務刪除成功時回傳 200 OK；當任務處於 IN_PROGRESS 狀態時回傳 409 Conflict。

GET/openapi/v1/print/multi-color

列出多色列印任務

返回你的多色列印任務列表。

Request

GET

/openapi/v1/print/multi-color

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-multi-color",
    "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "expires_at": 1700259201000,
    "task_error": null,
  "consumed_credits": 10
  }
]

參數

Name
page_num
Type
integer
預設值 1
Description
要返回的頁碼。頁碼從 1 開始。
Name
page_size
Type
integer
預設值 10
Description
每頁的任務數量，最多 100 個。
Name
sort_by
Type
string
Description
排序方式。
可用值：
- +created_at：最早優先
- -created_at：最新優先

一個分頁的多色列印任務物件列表。

GET/openapi/v1/print/multi-color/:id/stream

流式取得多色列印任務

以伺服器發送事件（SSE）的方式，流式取得多色列印任務的更新。

Request

GET

/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream

curl -N https://api.meshy.ai/openapi/v1/print/multi-color/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.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-multi-color",
  "model_urls": {
    "3mf": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.3mf?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1700259201000,
  "task_error": null,
"consumed_credits": 10
}

參數

Name
id
Type
path
Description
建立回應中回傳的任務 ID。

回傳值

以伺服器發送事件形式回傳的多色列印任務物件串流。

每個事件都包含完整的任務物件，其結構與 Get endpoint 回傳的結構相同。當任務處於 PENDING 或 IN_PROGRESS 狀態時，其結果欄位尚無值。

多色列印任務物件

多色列印任務物件描述了一次將 3D 模型轉換為多色 3MF 檔案的操作。它保存著狀態、progress，以及任務成功時產生的 3MF 檔案。

The 3D Print Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-multi-color",
  "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1700259201000,
  "task_error": null,
"consumed_credits": 10
}

Name
id
Type
string
Description
任務 ID。請將其視為一個不透明的字串，不要依賴其格式。
Name
type
Type
string
Description
任務類型，固定為 print-multi-color。
Name
model_urls
Type
object
Description
列印模型的下載連結，每種檔案格式對應一個。任務未產生某種格式時，相應的鍵不存在，而不是空字串。
- Name
  3mf
  Type
  string
  Description
  多色 3MF 檔案。
Name
progress
Type
integer
Description
任務完成的百分比。任務開始前為 0，成功後為 100。
Name
status
Type
string
Description
任務狀態，取值為 PENDING、IN_PROGRESS、SUCCEEDED、FAILED 或 CANCELED 之一。
Name
preceding_tasks
Type
integer
Description
排在該任務之前的任務數量。此值僅在任務處於 PENDING 狀態時才有意義。
Name
created_at
Type
timestamp
Description
任務建立時間，使用 Unix 毫秒時間戳表示。
Name
started_at
Type
timestamp
Description
任務開始時間，使用 Unix 毫秒時間戳表示。任務開始前為 0。
Name
finished_at
Type
timestamp
Description
任務完成時間，使用 Unix 毫秒時間戳表示。任務完成前為 0。
Name
expires_at
Type
timestamp
Description
任務結果的過期時間，使用 Unix 毫秒時間戳表示。任務完成前為 0。
Name
task_error
Type
object
Description
任務失敗時的錯誤詳情。參見錯誤。
Name
consumed_credits
Type
integer
Description
任務消耗的積分數量。當狀態為 PENDING、IN_PROGRESS 或 SUCCEEDED 時會顯示此欄位。對於 FAILED 的任務，此值為 0，因為 Meshy 會在任務失敗時退還積分。