Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the result through the unified Query Task Status endpoint.
Reconstruct 3D objects with Hunyuan 3D v3.1 Pro using a primary image and additional views, with support for PBR materials.

Models

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

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.

Output Options

Generate Type

  • generate_type: Optional. Choose Normal for a textured model or Geometry for a geometry-only white model.

Face Count

  • face_count: Optional. Set the target face count. Integer from 40000 to 1500000. Default: 500000.

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.

Back Image URL

  • back_image_url: Optional. Provide the back view as an image URL. Use a publicly accessible HTTP(S) URL.

Left Image URL

  • left_image_url: Optional. Provide the left view as an image URL. Use a publicly accessible HTTP(S) URL.

Right Image URL

  • right_image_url: Optional. Provide the right view as an image URL. Use a publicly accessible HTTP(S) URL.

Top Image URL

  • top_image_url: Optional. Provide the top view as an image URL. Use a publicly accessible HTTP(S) URL.

Bottom Image URL

  • bottom_image_url: Optional. Provide the bottom view as an image URL. Use a publicly accessible HTTP(S) URL.

Left Front Image URL

  • left_front_image_url: Optional. Provide the left front view as an image URL. Use a publicly accessible HTTP(S) URL.

Right Front Image URL

  • right_front_image_url: Optional. Provide the right front view as an image URL. Use a publicly accessible HTTP(S) URL.

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.

Authorizations

Authorization
string
header
required

Use VIDGO_API_KEY.

Body

application/json

Place model and callback_url at the request root and generation parameters inside input.

model
string
required
Example:

"hunyuan-3d/v3.1/pro/image-to-3d"

input
object
required
callback_url
string | null

Optional public HTTP(S) endpoint for task completion notifications. HTTPS is recommended. Omit, use null, or use an empty string to disable callbacks.

Response

Task submitted

code
enum<integer>
required
Available options:
200
data
object
required