格式轉換 API

格式轉換 API 可讓您將現有的 3D 模型轉換為不同的檔案格式。

POST/openapi/v1/convert

建立格式轉換任務

此端點用於建立新的格式轉換任務。

參數

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

  • Name
    input_task_id
    Type
    string
    必选
    Description

    需要轉換的已完成 Meshy 任務 ID。 該任務必須具有 SUCCEEDED 狀態。

  • Name
    model_url
    Type
    string
    必选
    Description

    可公開存取的 URL 或 Data URI，指向一個 3D 模型檔案。 支援的格式：.glb、.gltf、.obj、.fbx、.stl。 對於 Data URI，請使用 MIME 類型：application/octet-stream。

  • Name
    target_formats
    Type
    string[]
    必选
    Description

    轉換後的輸出格式清單。 可選值：glb、fbx、obj、usdz、blend、stl、3mf。

回傳值

回應的 result 欄位包含新建格式轉換任務的 id。

失敗模式

  • 400 - Bad Request

請求不合法。常見原因：

  • 缺少參數：必須提供 model_url 或 input_task_id 其中之一。
  • 缺少 target_formats：必須指定至少一種目標格式。
  • 輸入任務無效：input_task_id 必須參照一個成功的任務。
  • 模型格式無效：model_url 指向的檔案副檔名不受支援。
  • URL 無法存取：model_url 無法下載。
  • 401 - Unauthorized

驗證失敗。請檢查您的 API 金鑰。

  • 402 - Payment Required

點數不足，無法執行此任務。

  • 429 - Too Many Requests

您已超出請求頻率限制。

请求

POST
/openapi/v1/convert
curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

响应

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
GET/openapi/v1/convert/:id

取得格式轉換任務

此端點用於透過 ID 取得格式轉換任務。

參數

  • Name
    id
    Type
    path
    Description

    要取得的格式轉換任務 ID。

回傳值

回傳格式轉換任務物件。

请求

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

响应

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

刪除格式轉換任務

此端點可永久刪除一個格式轉換任務，包括所有相關的模型和資料。此操作無法復原。

路徑參數

  • Name
    id
    Type
    path
    Description

    要刪除的格式轉換任務 ID。

回傳值

成功時會回傳 200 OK。

请求

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

响应

// 成功则返回 200 Ok。
GET/openapi/v1/convert

列出格式轉換任務

此端點可讓您取得格式轉換任務清單。

參數

  • 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/convert
curl https://api.meshy.ai/openapi/v1/convert?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

响应

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

串流格式轉換任務

此端點會透過 Server-Sent Events (SSE) 串流回傳格式轉換任務的即時進度更新。

參數

  • Name
    id
    Type
    path
    Description

    要以串流方式取得的格式轉換任務 ID。

回傳值

回傳格式轉換任務物件的串流 Server-Sent Events。

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

请求

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

格式轉換任務物件

格式轉換任務物件表示一個格式轉換作業。

屬性

  • id · string

任務的唯一識別碼。

  • type · string

任務類型。值為 convert。

  • model_urls · object

轉換後模型檔案的可下載 URL。只有 target_formats 中指定的格式會包含 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 個積分）。FAILED 任務返回 0。