Creative Lab — 方塊小人 API

將來源照片轉換為方塊風格的收藏級3D人偶模型，分為兩個階段：原型階段會根據您輸入的照片產生風格化的概念圖，接著構建階段會將該概念圖轉換為帶貼圖的3D模型。這兩個階段透過 input_task_id 相互關聯。

POST /openapi/creative-lab/brick-figure/v1/prototype
POST /openapi/creative-lab/brick-figure/v1/build

POST/openapi/creative-lab/brick-figure/v1/prototype

創建方塊小人原型任務

根據來源照片生成單張方塊風格的概念圖。回傳的任務 ID 就是您在呼叫構建 endpoint 時需要傳入的 input_task_id。有關回應結構，請參閱方塊小人原型任務物件。

參數

Name
image_url
Type
string
必選
Description
供 Meshy 風格化為方塊小人的來源照片。目前支援 .jpg、.jpeg、.png 和 .webp 格式。
提供圖片的方式有兩種：
- 可公開存取的 URL：可從公開網際網路存取的 URL。
- Data URI：圖片的 base64 編碼 data URI。Data URI 範例：data:image/jpeg;base64,<your base64-encoded image data>。
Name
name
Type
string
Description
用於展示的選填任務名稱。最多 100 個字元。
Name
remove_background
Type
boolean
預設值 false
Description
設為 true 時，原型圖將以移除背景的透明 RGBA PNG 形式回傳，方便您將主體合成到任意背景上。

回傳值

回應中的 result 屬性包含新建立的方塊小人原型任務的任務 id。輪詢取得任務 endpoint 或訂閱串流介面，直到任務達到 SUCCEEDED 狀態，然後將該 ID 作為 input_task_id 傳入構建 endpoint。

失敗模式

Name
400 - Bad Request
Description
請求無法被接受。常見原因：
- 缺少參數：image_url 為必填項。
- 無效的圖片格式：提供的 image_url 不是受支援的格式（.jpg、.jpeg、.png、.webp）。
- 圖片尺寸超出範圍：圖片過小、超過最大檔案大小限制，或超過最大像素數限制。
- URL 無法存取：無法下載該 image_url（404 或 timeout）。
- 無效的 Data URI：base64 字串格式有誤。
- 內容被標記：輸入圖片被 NSFW moderation 標記。
Name
401 - Unauthorized
Description
身份驗證失敗。請檢查您的 API key。
Name
402 - Payment Required
Description
積分不足，無法執行此任務。
Name
403 - Forbidden
Description
輸入圖片因涉嫌智慧財產權侵權而被標記。
Name
429 - Too Many Requests
Description
您已超出速率限制。

Request

POST

/openapi/creative-lab/brick-figure/v1/prototype

# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

POST/openapi/creative-lab/brick-figure/v1/build

建立方塊小人建置任務

從一個已成功的原型任務生成最終的帶貼圖 3D 方塊小人。建置過程執行與 Image to 3D 相同的圖片轉 3D 流水線，因此回應物件格式和輸出 URL 清單完全一致。回應結構請參閱方塊小人建置任務物件。

參數

Name
input_task_id
Type
string
必選
Description
透過同一個 OpenAPI endpoint 建立的原型任務的任務 ID。該原型必須使用相同的 API key 建立，必須已達到 SUCCEEDED 狀態，並且必須只生成了一張候選圖片。
透過 webapp 建立的原型任務不被接受——建置 endpoint 只接受由 POST /openapi/creative-lab/brick-figure/v1/prototype 生成的原型任務，其他來源一律回傳 404 拒絕。
Name
name
Type
string
Description
用於顯示的可選任務名稱。最多 100 個字元。

回傳值

回應中的 result 屬性包含新建立的方塊小人建置任務的任務 id。輪詢取得任務 endpoint 或訂閱串流介面，直到任務達到 SUCCEEDED 狀態，然後從 model_urls.glb 下載帶貼圖的 GLB（如果你的下游流水線更傾向於使用 OBJ，也可以從 model_urls.obj 和 model_urls.mtl 下載 OBJ + MTL 檔案對）。

失敗情形

Name
400 - Bad Request
Description
請求內容不可接受。常見原因：
- 缺少參數：input_task_id 為必填項。
- 無效的 UUID：input_task_id 不是有效的 UUID。
- 父任務未成功：所引用的原型任務尚未達到 SUCCEEDED 狀態。
- 無候選圖片：原型任務已成功，但未生成候選圖片。
Name
401 - Unauthorized
Description
身分驗證失敗。請檢查你的 API key。
Name
402 - Payment Required
Description
credits 不足，無法執行此任務。
Name
404 - Not Found
Description
所引用的原型任務不存在、屬於其他使用者，或是透過 webapp 建立的（只有 API 模式下的原型任務才能鏈式生成建置任務）。
Name
429 - Too Many Requests
Description
你已超出速率限制。

Request

POST

/openapi/creative-lab/brick-figure/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

取得方塊小人任務

根據有效的任務 id 取得原型（prototype）或構建（build）任務。URL 路徑必須與任務所處的階段相符——透過 /prototype/:id 取得構建任務會回傳 404，反之亦然。

回應結構請參閱方塊小人原型任務物件和方塊小人構建任務物件。

參數

Name
id
Type
path
Description
要取得的方塊小人任務的唯一識別碼。

回傳

回應包含方塊小人任務物件，其結構取決於所請求的階段。

Request

GET

/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

DELETE/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

刪除方塊小人任務

取消一個方塊小人任務。如果任務仍處於 PENDING 狀態，建立時消耗的積分將被退還。已處於 IN_PROGRESS 狀態的任務會被取消但不予退款（此時工作程序可能已經在消耗資源）。已經達到終止狀態（SUCCEEDED、FAILED、CANCELED）的任務無法被取消。

URL 路徑必須與任務所處階段相符 —— 對 /prototype/:buildId 執行 DELETE 操作會回傳 404。

路徑參數

Name
id
Type
path
Description
要取消的方塊小人任務的唯一識別碼。

回傳值

成功時回傳 204 No Content，回應內容為空。

失敗情況

Name
400 - Bad Request
Description
該任務已處於終止狀態，無法被取消。
Name
404 - Not Found
Description
該任務不存在、屬於其他使用者，或其所處階段與 URL 路徑不符。

Request

DELETE

/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id/stream

流式取得方塊小人任務

透過 Server-Sent Events (SSE) 即時串流取得方塊小人任務的更新。 URL 路徑必須與任務所處的階段相符——在 /prototype/:buildId/stream 處開啟串流會發出單一個 event: error payload，其中包含 status_code: 404，隨後關閉該串流。

參數

Name
id
Type
path
Description
要進行串流取得的方塊小人任務的唯一識別碼。

回傳

以 Server-Sent Events 的形式回傳一個由方塊小人原型（Brick Figure Prototype）或方塊小人構建（Brick Figure Build）任務物件組成的串流。對於 PENDING 或 IN_PROGRESS 狀態的任務，回應串流中只會包含必要的 progress 和 status 欄位。

Request

GET

/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)

獲取方塊小人任務列表

獲取單個階段的方塊小人任務的分頁列表。URL 路徑決定階段——/prototype 返回原型（prototype）任務；/build 返回構建（build）任務。另一個階段的任務不會包含在任一回應中。

路徑參數

Name
stage
Type
path
必選
Description
prototype 或 build 之一。該集合僅返回階段與 URL 相符的任務——請求 /prototype 永遠不會返回構建任務，反之亦然。

查詢參數

Name
page_num
Type
integer
預設值 1
Description
用於分頁的頁碼。
Name
page_size
Type
integer
預設值 10
Description
分頁大小限制。最大允許值為 100 項。
Name
sort_by
Type
string
預設值 -created_at
Description
用於排序的欄位。可用值：
- +created_at：按建立時間升冪排序。
- -created_at：按建立時間降冪排序。

返回值

返回按階段劃分的任務物件的分頁列表——列出 /prototype 時為方塊小人原型任務物件，列出 /build 時為方塊小人構建任務物件。

Request

GET

/openapi/creative-lab/brick-figure/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-brick-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

方塊小人原型任務物件

Brick Figure Prototype Task 物件是 Meshy 用來追蹤任務的工作單位，用於根據來源照片生成方塊風格的概念圖。此階段的輸出會透過 input_task_id 連結到建構階段。

屬性

Name
id
Type
string
Description
任務的唯一識別碼。雖然我們在實作細節中使用 k-可排序的 UUID 作為任務 id，但你不應對 id 的格式做任何假設。
Name
type
Type
string
Description
任務的類型。該值為 creative-lab-brick-figure-prototype。
Name
name
Type
string
Description
建立任務時提供的任務名稱。如果未提供名稱，則為空字串。
Name
status
Type
string
Description
任務的狀態。可能的值為 PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED 之一。
Name
progress
Type
integer
Description
任務的 progress。如果任務尚未開始，此屬性將為 0。任務成功後，此值將變為 100。
Name
created_at
Type
timestamp
Description
任務建立時的時間戳，以毫秒為單位。
時間戳表示自 1970 年 1 月 1 日 UTC 起經過的毫秒數，遵循 RFC 3339 標準。例如，格林威治標準時間 2023 年 9 月 1 日星期五中午 12:00:00 表示為 1693569600000。這適用於 Meshy API 中的所有時間戳。
Name
started_at
Type
timestamp
Description
任務開始時的時間戳，以毫秒為單位。如果任務尚未開始，此屬性將為 null。
Name
finished_at
Type
timestamp
Description
任務完成時的時間戳，以毫秒為單位。如果任務尚未完成，此屬性將為 null。
Name
expires_at
Type
timestamp
Description
任務結果過期時的時間戳，以毫秒為單位。
Name
preceding_tasks
Type
integer
Description
前置任務的數量。
此欄位的值僅在任務狀態為 PENDING 時才有意義。
Name
task_error
Type
object
Description
失敗任務的錯誤詳情。完整的 task_error 物件參考請參閱錯誤。
Name
consumed_credits
Type
integer
Description
此任務消耗的 credits 數量。當任務狀態為 PENDING、IN_PROGRESS 或 SUCCEEDED 時會顯示該欄位。對於 FAILED 任務，回傳 0（失敗時積分會被退還）。
Name
image_urls
Type
array of strings
Description
此原型任務生成的概念圖候選項的可下載 URL。目前 API 始終只回傳一個候選項；該欄位設計為陣列，以便未來版本可以在不產生破壞性變更的情況下呈現多個候選項。

Example Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

方塊小人構建任務物件

方塊小人構建任務物件是 Meshy 用來追蹤從成功的原型任務生成帶貼圖的3D 方塊小人的工作單元。它運行與 Image to 3D 相同的影象生成 3D 流程，因此輸出欄位與該 endpoint 的任務物件保持一致。

屬性

Name
id
Type
string
Description
任務的唯一識別碼。
Name
type
Type
string
Description
任務的類型。取值為 creative-lab-brick-figure-build。
Name
name
Type
string
Description
建立任務時提供的任務名稱。如果未提供名稱，則為空字串。
Name
status
Type
string
Description
任務的狀態。可能的取值為 PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED 之一。
Name
progress
Type
integer
Description
任務的進度。如果任務尚未開始，此屬性為 0。任務成功後，該值將變為 100。
Name
created_at
Type
timestamp
Description
任務建立時間的時間戳，單位為毫秒。
Name
started_at
Type
timestamp
Description
任務開始時間的時間戳，單位為毫秒。
Name
finished_at
Type
timestamp
Description
任務完成時間的時間戳，單位為毫秒。
Name
expires_at
Type
timestamp
Description
任務結果過期時間的時間戳，單位為毫秒。
Name
preceding_tasks
Type
integer
Description
排在前面的任務數量。僅當狀態為 PENDING 時該欄位才有意義。
Name
task_error
Type
object
Description
失敗任務的錯誤詳情。完整的 task_error 物件參考請參見錯誤。
Name
consumed_credits
Type
integer
Description
此任務消耗的積分數量。對於 FAILED 任務返回 0（失敗時會退還積分）。
Name
prompt
Type
string
Description
方塊小人構建任務此欄位始終為空。為與 Image to 3D 所使用的共享 V2ImageTo3DTaskResponse 結構保持跨 endpoint 相容而保留此欄位。
Name
negative_prompt
Type
string
Description
方塊小人構建任務此欄位始終為空。為保持跨 endpoint 相容而保留此欄位。
Name
texture_prompt
Type
string
Description
方塊小人構建任務此欄位始終為空。為保持跨 endpoint 相容而保留此欄位。
Name
texture_image_url
Type
string
Description
方塊小人構建任務此欄位始終為空。為保持跨 endpoint 相容而保留此欄位。
Name
model_urls
Type
object
Description
生成的 3D 模型的可下載 URL。方塊小人構建會輸出一個帶貼圖的 GLB，以及適用於偏好 Wavefront OBJ 的流程的 OBJ + MTL 組合。該欄位的結構與 Image to 3D 的 model_urls 物件一致，因此未來新增格式時不會產生破壞性變更。
- Name
  glb
  Type
  string
  Description
  帶貼圖 GLB 檔案的可下載 URL。
- Name
  obj
  Type
  string
  Description
  Wavefront OBJ 檔案（幾何體 + UV）的可下載 URL。
- Name
  mtl
  Type
  string
  Description
  OBJ 配套 MTL 材質檔案的可下載 URL。請與 obj 及 texture_urls[0].base_color 中的條目配合使用。
Name
thumbnail_url
Type
string
Description
模型檔案縮圖的可下載 URL。
Name
texture_urls
Type
array
Description
此任務生成的貼圖 URL 物件陣列。目前僅包含一個帶有基礎顏色貼圖的物件。
- Name
  base_color
  Type
  string
  Description
  基礎顏色貼圖圖像的可下載 URL。

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}