> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# 通过 Comfy Router 使用混元 3D Uv

> 通过 Comfy Router 调用 tencent/hunyuan-3d-uv：端点、请求结构与 Router 返回的响应。

`tencent/hunyuan-3d-uv` 的 API 参考文档，该模型来自腾讯，由 Comfy Router 提供服务。

## 快速开始

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

**模型 ID:** `tencent/hunyuan-3d-uv`

**端点:** `POST https://api.comfy.org/v2/models/tencent/hunyuan-3d-uv`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "tencent/hunyuan-3d-uv",
              {
                  "File": {
                      "Type": "GLB",
                      "Url": "https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb",
                  },
              },
          )

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("tencent/hunyuan-3d-uv", {
        File: {
          Type: "GLB",
          Url: "https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb",
        },
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/tencent/hunyuan-3d-uv \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"File\": {\"Type\":\"GLB\",\"Url\":\"https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb\"}}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "tencent/hunyuan-3d-uv",
              {
                  "File": {
                      "Type": "GLB",
                      "Url": "https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb",
                  },
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("tencent/hunyuan-3d-uv", {
        File: {
          Type: "GLB",
          Url: "https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb",
        },
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

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

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/tencent/hunyuan-3d-uv/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"File\": {\"Type\":\"GLB\",\"Url\":\"https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb\"}}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/tencent/hunyuan-3d-uv/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/tencent/hunyuan-3d-uv/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 架构

### 输入

<ParamField body="File" type="object">
  用于 UV 展开的 3D 文件输入
</ParamField>

<ParamField body="File.Type" type="string" required>
  3D 文件格式类型

  可能的值：`FBX`、`OBJ`、`GLB`
</ParamField>

<ParamField body="File.Url" type="string (uri)" required>
  需要进行 UV 展开的 3D 文件的 URL

  格式：`uri`
</ParamField>

由 Router 在 `GET /v2/models/tencent/hunyuan-3d-uv/openapi.json` 提供的架构生成，这也是它在请求到达提供商之前用于校验调用的同一份文档。

### 输出

<ResponseField name="Response" type="object" required />

<ResponseField name="Response.ErrorCode" type="string">
  腾讯的错误码，文档中记载无错误时为空字符串。一旦存在 `Status`，Router 就不会读取它。
</ResponseField>

<ResponseField name="Response.ErrorMessage" type="string">
  腾讯的报错信息，文档中记载无错误时为空字符串。一旦存在 `Status`，Router 就不会读取它。
</ResponseField>

<ResponseField name="Response.RequestId" type="string">
  腾讯自己的请求标识，用于向腾讯排查问题。它既不是任务 ID，也不是资产。
</ResponseField>

<ResponseField name="Response.ResultFile3Ds" type="object[]" required>
  已完成任务生成的 3D 文件。在 Router 返回的文档中存在且非空；至少有一个条目带有可获取的 `Url`。这些链接来自腾讯自身，文档中记载其有效期为 24 小时。
</ResponseField>

<ResponseField name="Response.ResultFile3Ds[].PreviewImageUrl" type="string (uri)">
  预览图像网址

  格式：`uri`
</ResponseField>

<ResponseField name="Response.ResultFile3Ds[].Type" type="string">
  3D 文件格式

  可能的值：`GLB`、`OBJ`
</ResponseField>

<ResponseField name="Response.ResultFile3Ds[].Url" type="string (uri)">
  文件网址（有效期 24 小时）

  格式：`uri`
</ResponseField>

<ResponseField name="Response.Status" type="string" required>
  可能的值：`DONE`
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "File": {
    "Type": "GLB",
    "Url": "https://vcg-test-1258344699.cos.ap-guangzhou.myqcloud.com/test/3d/test.glb"
  }
}
```

### 输出

```json theme={null}
{
  "Response": {
    "ErrorCode": "",
    "ErrorMessage": "",
    "RequestId": "9a1c0d4e-77b2-4e0c-8f2e-2f9a1c0d4e77",
    "ResultFile3Ds": [
      {
        "PreviewImageUrl": "https://example.invalid/tencent/hunyuan-3d-uv/preview.png",
        "Type": "GLB",
        "Url": "https://example.invalid/tencent/hunyuan-3d-uv/unwrapped.glb"
      }
    ],
    "Status": "DONE"
  }
}
```

## 发布前须知

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

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

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

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

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