> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-mintlify-theme-mint.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 将 Remesh 与 Comfy Router 配合使用

> 通过 Comfy Router 调用 meshy/remesh：端点、请求形状以及 Router 返回的响应。

`meshy/remesh` 的 API 参考，由 Comfy Router 提供，来源为 Meshy。

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `COMFY_API_KEY`。Python、TypeScript 和 Swift 代码片段使用 Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`，以及 [`ComfySwiftSDK`](https://github.com/Comfy-Org/comfy-swift-sdk) Swift 包）；cURL 代码片段则是通过原始 HTTP 发出的同一调用。

**模型 ID：** `meshy/remesh`

**端点：** `POST https://api.comfy.org/v2/models/meshy/remesh`

<Tabs>
  <Tab title="等待结果">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 从环境变量中读取 COMFY_API_KEY。
      # SDK 会自动创建幂等键，并在自动重试时复用它。
      with Comfy() as client:
          result = client.models.run(
              "meshy/remesh",
              {
                  "input_task_id": "0193abcd-0000-0000-0000-000000000000",
                  "origin_at": "bottom",
                  "resize_height": 1,
                  "target_formats": ["glb", "fbx"],
                  "target_polycount": 50000,
                  "topology": "quad",
              },
          )

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建幂等键，并在自动重试时复用它。
      const { data } = await comfy.models.run("meshy/remesh", {
        input_task_id: "0193abcd-0000-0000-0000-000000000000",
        origin_at: "bottom",
        resize_height: 1,
        target_formats: ["glb", "fbx"],
        target_polycount: 50000,
        topology: "quad",
      });

      console.log(data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会为每次调用生成幂等键，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let result = try await client.models.run(
          "meshy/remesh",
          input: [
              "input_task_id": "0193abcd-0000-0000-0000-000000000000",
              "origin_at": "bottom",
              "resize_height": 1,
              "target_formats": ["glb", "fbx"],
              "target_polycount": 50000,
              "topology": "quad",
          ]
      )

      print(result.output)
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/meshy/remesh \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input_task_id\": \"0193abcd-0000-0000-0000-000000000000\", \"origin_at\": \"bottom\", \"resize_height\": 1, \"target_formats\": [\"glb\",\"fbx\"], \"target_polycount\": 50000, \"topology\": \"quad\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="排队并稍后收集">
    将相同的请求体发送到 `POST https://api.comfy.org/v2/models/meshy/remesh/requests`。运行被受理后，Router 会立即返回 `201` 和 `request_id`；结果就绪后，可以从本进程或其他进程收集。状态、取消与收集的细节见 [队列投递](/zh/development/comfy-router/queue)。

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 从环境变量中读取 COMFY_API_KEY。
      # 每次调用 submit() 都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      with Comfy() as client:
          handle = client.models.submit(
              "meshy/remesh",
              {
                  "input_task_id": "0193abcd-0000-0000-0000-000000000000",
                  "origin_at": "bottom",
                  "resize_height": 1,
                  "target_formats": ["glb", "fbx"],
                  "target_polycount": 50000,
                  "topology": "quad",
              },
          )
          print("request_id:", handle.request_id)  # 加上模型 ID，另一个进程所需的信息就齐全了

          # 轮询直到请求完成，每次等待服务器指定的 Retry-After。
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # 提供商自身的响应载荷，与 models.run() 返回的值相同。
          # 失败或已取消的请求会在这里抛出类型化的 Router 错误。
          result = handle.get()

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次调用 submit() 都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      const handle = await comfy.models.submit("meshy/remesh", {
        input_task_id: "0193abcd-0000-0000-0000-000000000000",
        origin_at: "bottom",
        resize_height: 1,
        target_formats: ["glb", "fbx"],
        target_polycount: 50000,
        topology: "quad",
      });
      console.log("requestId:", handle.requestId); // 加上模型 ID，另一个进程所需的信息就齐全了

      // 轮询直到请求完成，每次等待服务器指定的 Retry-After。
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。
      const result = await handle.get();

      console.log(result.data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次调用 submit() 都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let handle = try await client.models.submit(
          "meshy/remesh",
          input: [
              "input_task_id": "0193abcd-0000-0000-0000-000000000000",
              "origin_at": "bottom",
              "resize_height": 1,
              "target_formats": ["glb", "fbx"],
              "target_polycount": 50000,
              "topology": "quad",
          ]
      )
      print("requestId:", handle.requestId)  // 加上模型 ID，另一个进程所需的信息就齐全了

      // 轮询直到请求完成，每次等待服务器指定的 Retry-After。
      for try await update in handle.events() {
          print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
      }

      // 提供商自身的响应载荷，与 models.run() 返回的值相同。
      // 失败或已取消的请求会在这里抛出类型化的 Router 错误。
      let result = try await handle.result()

      print(result.output)
      ```

      ```bash cURL theme={null}
      # 1. 提交。Router 返回 201，并带有 request_id、status_url、response_url 和 cancel_url。
      curl https://api.comfy.org/v2/models/meshy/remesh/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input_task_id\": \"0193abcd-0000-0000-0000-000000000000\", \"origin_at\": \"bottom\", \"resize_height\": 1, \"target_formats\": [\"glb\",\"fbx\"], \"target_polycount\": 50000, \"topology\": \"quad\"}"

      # 2. 轮询直到状态为 COMPLETED，每次等待响应中指定的 Retry-After 秒数。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/meshy/remesh/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集。返回 200 时附带模型的原始输出；仍在运行时返回 202 和状态响应体。
      curl https://api.comfy.org/v2/models/meshy/remesh/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<ParamField body="convert_format_only" type="boolean" default="false">
  如果为 true，则仅更改输入模型文件的格式，忽略拓扑、resize\_height 和 target\_polycount 等其他输入。
</ParamField>

<ParamField body="input_task_id" type="string">
  您想要重新网格化的、已完成的 Image to 3D 或 Text to 3D 使用例的 ID。如果未提供 model\_url，则必填。
</ParamField>

<ParamField body="model_url" type="string">
  可公开访问的 3D模型 URL 或数据 URI。支持的格式：glb、gltf、obj、fbx、stl。如果未提供 input\_task\_id，则必填。
</ParamField>

<ParamField body="origin_at" type="string">
  原点的位置。

  可选值：`bottom`、`center`、\`\`
</ParamField>

<ParamField body="resize_height" type="number" default="0">
  将模型调整大小到以米为单位的特定高度。0 表示不调整大小。
</ParamField>

<ParamField body="target_formats" type="`glb`, `fbx`, `obj`, `usdz`, `blend`, `stl`[]" default="[&#x22;glb&#x22;]">
  重新网格化后模型的目标格式列表。
</ParamField>

<ParamField body="target_polycount" type="integer" default="30000">
  指定已生成模型的目标多边形数量。有效范围为 100 到 300,000。

  范围：`100` 到 `300000`
</ParamField>

<ParamField body="topology" type="string" default="&#x22;triangle&#x22;">
  指定已生成模型的拓扑结构。

  可选值：`quad`、`triangle`
</ParamField>

本文档根据 Router 在 `GET /v2/models/meshy/remesh/openapi.json` 提供的 schema 生成，该文档与它在请求到达提供商之前用于校验调用的文档相同。

### 输出

<ResponseField name="created_at" type="integer">
  使用例创建时的时间戳，单位为毫秒。

  格式：`int64`
</ResponseField>

<ResponseField name="finished_at" type="integer">
  使用例已完成时的时间戳，单位为毫秒。如果未完成则为 0。

  格式：`int64`
</ResponseField>

<ResponseField name="id" type="string" required>
  使用例的唯一标识符。
</ResponseField>

<ResponseField name="model_urls" type="object">
  可下载的重新网格化后 3D模型文件 URL。
</ResponseField>

<ResponseField name="model_urls.blend" type="string">
  可下载的 Blender 文件 URL。
</ResponseField>

<ResponseField name="model_urls.fbx" type="string">
  可下载的 FBX 文件 URL。
</ResponseField>

<ResponseField name="model_urls.glb" type="string">
  可下载的 GLB 文件 URL。
</ResponseField>

<ResponseField name="model_urls.obj" type="string">
  可下载的 OBJ 文件 URL。
</ResponseField>

<ResponseField name="model_urls.stl" type="string">
  可下载的 STL 文件 URL。
</ResponseField>

<ResponseField name="model_urls.usdz" type="string">
  可下载的 USDZ 文件 URL。
</ResponseField>

<ResponseField name="preceding_tasks" type="integer">
  前面排队的使用例数量。仅当状态为 PENDING 时有意义。
</ResponseField>

<ResponseField name="progress" type="integer">
  使用例的进度。未开始时为 0，成功时为 100。

  范围：`0` 到 `100`
</ResponseField>

<ResponseField name="started_at" type="integer">
  使用例开始时的时间戳，单位为毫秒。如果未开始则为 0。

  格式：`int64`
</ResponseField>

<ResponseField name="status" type="string" required>
  可选值：`SUCCEEDED`
</ResponseField>

<ResponseField name="task_error" type="object">
  错误对象，在使用例失败时包含报错信息。
</ResponseField>

<ResponseField name="task_error.message" type="string">
  详细的报错信息。
</ResponseField>

<ResponseField name="type" type="string">
  Remesh 使用例的类型。

  可选值：`remesh`
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "input_task_id": "0193abcd-0000-0000-0000-000000000000",
  "origin_at": "bottom",
  "resize_height": 1,
  "target_formats": [
    "glb",
    "fbx"
  ],
  "target_polycount": 50000,
  "topology": "quad"
}
```

### 输出

```json theme={null}
{
  "created_at": 1767225600000,
  "finished_at": 1767225663000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "model_urls": {
    "fbx": "https://example.invalid/meshy/remesh/model.fbx",
    "glb": "https://example.invalid/meshy/remesh/model.glb",
    "obj": "https://example.invalid/meshy/remesh/model.obj"
  },
  "progress": 100,
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "type": "remesh"
}
```

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](/zh/development/comfy-router/reference#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](/zh/development/comfy-router/limitations)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](/zh/development/api-development/sdks)。

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/headers">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/api">
    模型发现、验证错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>