格式转换 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 或数据 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

任务失败时的错误对象。详情请参阅 Errors。

  • consumed_credits · integer

此任务消耗的积分数（每个转换任务消耗1个积分）。FAILED 任务返回 0。