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

# Hunyuan 3D v3.1 Rapid 图生 3D

> Hunyuan 3D v3.1 Rapid API 根据参考图片生成 3D 模型，支持可选的文本引导和几何体生成。

> [!TIP]
>
> 1. 提交后会返回 `task_id`。如果提供了 `callback_url`，当任务状态变为 `finished` 或 `failed` 时，系统会向 `callback_url` 发送 POST 请求。
> 2. 无论是否提供 `callback_url`，都可以通过统一的[查询任务状态](https://docs.vidgo.ai/zh/api-manual/task-management/status.md)接口获取结果。

使用 Hunyuan 3D v3.1 Rapid 图生 3D 根据参考图片生成 3D 模型，支持可选的文本引导和几何体生成。

## 模型

* **hunyuan-3d/v3.1/rapid/image-to-3d** - 根据图片生成 3D 模型。

## 功能

* 根据图片生成 3D 模型。
* `image_urls` 只接受 1 张图片。
* 从任务结果中获取模型资源，以及可用的预览图或辅助文件。

## 输出选项

### 启用几何体模式

* `enable_geometry`：可选。设为 `true` 生成仅含几何体的白模，设为 `false` 生成带纹理的模型。

## 高级参数

`model` 和可选的 `callback_url` 放在请求根级。所有工作流参数（包括输出选项）都放在 `input` 内。

使用下列输入参数。图片输入请提供可公开访问的 HTTP(S) URL。

### 提示词

* `prompt`：可选。描述所需的 3D 物体。最小长度：**1 个字符**。
* 提供此参数时请使用非空字符串。

### 图片 URL

* `image_urls`：必填。提供可公开访问的图片 URL。只能提供 1 项，每项必须是 HTTP(S) URL。

### PBR

* `enable_pbr`：可选。设为 `true` 时在纹理模式下生成 PBR 材质。仅几何体生成优先于此设置。

## 输出文件

* 读取返回的 `files` 数组中的每一项。
* 模型资源为 `file_type: "3d"`；预览图为 `file_type: "image"`。
* 其他产物可能为 `file_type: "other"`。保留返回的纹理、材质文件和文件元数据。


## OpenAPI

````yaml zh/api-manual/3d-series/hunyuan-3d-v3-1-rapid-image-to-3d.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Vidgo API - Hunyuan 3D v3.1 Rapid 图生 3D
  description: 使用 Hunyuan 3D v3.1 Rapid 根据参考图片生成 3D 模型，支持可选的文本引导和几何体生成。
  version: 1.0.0
servers:
  - url: https://api.vidgo.ai
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - 3D Series
      summary: Hunyuan 3D v3.1 Rapid 图生 3D
      description: >-
        使用下列输入参数生成 3D 资产。model 和 callback_url 放在请求根级。模型资源、预览图和附带文件从返回的 files
        数组读取。
      operationId: submit_hunyuan_3d_v3_1_rapid_image_to_3d
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - model
                - input
              additionalProperties: true
              properties:
                model:
                  type: string
                  example: hunyuan-3d/v3.1/rapid/image-to-3d
                input:
                  type: object
                  properties:
                    prompt:
                      type: string
                      description: 可选，用非空字符串描述所需的 3D 物体。
                      minLength: 1
                    image_urls:
                      type: array
                      items:
                        type: string
                        format: uri
                      minItems: 1
                      maxItems: 1
                      description: 只能提供一个可公开访问的 HTTP(S) 图片 URL。
                    enable_geometry:
                      type: boolean
                      description: 设为 true 时生成仅含几何体的白模。
                    enable_pbr:
                      type: boolean
                      description: 设为 true 时在纹理模式下生成 PBR 材质。仅几何体生成优先于此设置。
                  additionalProperties: false
                  required:
                    - image_urls
                callback_url:
                  type: string
                  nullable: true
                  description: >-
                    可选的公开 HTTP(S) 地址，用于接收任务完成通知。建议使用 HTTPS。省略、设为 null
                    或空字符串即不发送回调。
              description: model 和 callback_url 放在请求根级，生成参数放在 input 内。
            examples:
              basic:
                summary: 基础工作流
                value:
                  model: hunyuan-3d/v3.1/rapid/image-to-3d
                  input:
                    image_urls:
                      - https://example.com/image.png
                    enable_pbr: true
                    enable_geometry: false
              callback:
                summary: 接收完成回调
                value:
                  model: hunyuan-3d/v3.1/rapid/image-to-3d
                  input:
                    image_urls:
                      - https://example.com/image.png
                    enable_pbr: true
                    enable_geometry: false
                  callback_url: https://your-domain.com/callback
      responses:
        '200':
          description: 任务已提交
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                  - data
                properties:
                  code:
                    type: integer
                    enum:
                      - 200
                  data:
                    type: object
                    required:
                      - task_id
                      - status
                      - created_time
                    properties:
                      task_id:
                        type: string
                      status:
                        type: string
                        enum:
                          - not_started
                          - running
                          - finished
                          - failed
                      created_time:
                        type: string
                        format: date-time
              example:
                code: 200
                data:
                  task_id: task-unified-example
                  status: running
                  created_time: '2026-09-10T08:00:00'
        '400':
          description: 请求校验或账户余额检查失败
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '401':
          description: 凭证无效
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '403':
          description: 拒绝访问
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '404':
          description: 模型不存在或已停用
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '408':
          description: 请求超时
          content:
            text/plain:
              schema:
                type: string
              example: Request timeout
        '422':
          description: JSON 无效或请求体不是对象
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '429':
          description: 超出频率限制或 API Key 积分限额
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '500':
          description: 内部错误
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '502':
          description: 生成任务创建失败
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '503':
          description: 所请求的模型暂时不可用
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 使用 VIDGO_API_KEY。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.