> ## 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 Image to 3D

> Create a 3D model from a reference image with Hunyuan 3D v3.1 Rapid, with optional text guidance and geometry generation.

<Tip>
  1. Submit the request with `VIDGO_API_KEY`. A `task_id` is returned immediately. Keep it until the task reaches `finished` or `failed`.
  2. Use [Query Task Status](/api-manual/task-management/status) to retrieve the result. If you provide a `callback_url`, Vidgo sends the result to your [webhook](/api-manual/task-management/webhooks) when the task finishes or fails.
</Tip>

# Hunyuan 3D v3.1 Rapid Image to 3D

Create a 3D model from a reference image with Hunyuan 3D v3.1 Rapid, with optional text guidance and geometry generation.

## Available Models

* **hunyuan-3d/v3.1/rapid/image-to-3d** - Generate a 3D model from an image.

## Output Options

### Enable Geometry

* `enable_geometry`: Optional. Set `true` for a geometry-only white model or `false` for textured generation.

## Key Features

* Generate a 3D model from an image.
* Accepts exactly 1 image in `image_urls`.
* Retrieve model assets and available previews or supporting files from the task result.

## Advanced Parameters

Set `model` and optional `callback_url` at the request root. Place all workflow parameters, including output options, inside `input`.

Use the input parameters listed below. Provide publicly accessible HTTP(S) URLs for image inputs.

### Prompt

* `prompt`: Optional. Describe the desired 3D object. Minimum length: **1 character**.
* Use a nonblank string when providing this parameter.

### Image URLs

* `image_urls`: Required. Provide publicly accessible image URLs. Supply exactly 1 item. Each item must be an HTTP(S) URL.

### PBR

* `enable_pbr`: Optional. Set `true` to generate PBR materials in textured mode. Geometry-only generation takes precedence over this setting.

## Output Files

* Read every item in the returned `files` array.
* Model assets use `file_type: "3d"`; previews use `file_type: "image"`.
* Additional artifacts may use `file_type: "other"`. Retain returned textures, material files, and file metadata.


## OpenAPI

````yaml 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 Image to 3D
  description: >-
    Create a 3D model from a reference image with Hunyuan 3D v3.1 Rapid, with
    optional text guidance and geometry generation.
  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 Image to 3D
      description: >-
        Generate a 3D asset with the input parameters below. Place model and
        callback_url at the request root. Read the returned files array for
        model assets, previews, and companion 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: >-
                        Optionally describe the desired 3D object using a
                        nonblank string.
                      minLength: 1
                    image_urls:
                      type: array
                      items:
                        type: string
                        format: uri
                      minItems: 1
                      maxItems: 1
                      description: >-
                        Provide exactly one publicly accessible HTTP(S) image
                        URL.
                    enable_geometry:
                      type: boolean
                      description: Set true to generate a geometry-only white model.
                    enable_pbr:
                      type: boolean
                      description: >-
                        Set true to generate PBR materials in textured mode.
                        Geometry-only generation takes precedence over this
                        setting.
                  additionalProperties: false
                  required:
                    - image_urls
                callback_url:
                  type: string
                  nullable: true
                  description: >-
                    Optional public HTTP(S) endpoint for task completion
                    notifications. HTTPS is recommended. Omit, use null, or use
                    an empty string to disable callbacks.
              description: >-
                Place model and callback_url at the request root and generation
                parameters inside input.
            examples:
              basic:
                summary: Basic workflow
                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: Receive a completion callback
                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: Task submitted
          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: Request validation or account balance check failed
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '401':
          description: Invalid credentials
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '404':
          description: Unknown or disabled model
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '408':
          description: Request timed out
          content:
            text/plain:
              schema:
                type: string
              example: Request timeout
        '422':
          description: Invalid JSON or non-object request body
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '429':
          description: Rate or API key credit limit exceeded
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '502':
          description: Generation task creation failed
          content:
            application/json:
              schema:
                type: object
                required:
                  - detail
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties: true
                      - type: array
                        items: {}
        '503':
          description: Model configuration or capability is not approved
          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: Use VIDGO_API_KEY.

````