Hunyuan 3D Pro Image to 3D | Image to 3D

fal-ai/hunyuan-3d/v3.1/pro/image-to-3d

Generate 3D models from images with Hunyuan 3D Pro

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Pro Image To 3D

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/hunyuan-3d/v3.1/pro/image-to-3d", {
  input: {
    input_image_url: "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.png"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/hunyuan-3d/v3.1/pro/image-to-3d", {
  input: {
    input_image_url: "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.png"
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/hunyuan-3d/v3.1/pro/image-to-3d", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/hunyuan-3d/v3.1/pro/image-to-3d", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Auto uploads

The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).

Read more about file handling in our file upload guide.

5. Schema#

Input#

input_image_url string* required

Front view image URL. Resolution: 128-5000px, max 8MB, formats: JPG/PNG/WEBP. Tips: simple background, single object, object >50% of frame.

back_image_url string

Optional back/rear view image URL (JPG/PNG recommended).

left_image_url string

Optional left side view image URL (JPG/PNG recommended).

right_image_url string

Optional right side view image URL (JPG/PNG recommended).

top_image_url string

Optional top view image URL (v3.1 exclusive, JPG/PNG recommended).

bottom_image_url string

Optional bottom view image URL (v3.1 exclusive, JPG/PNG recommended).

left_front_image_url string

Optional left-front 45 degree angle view image URL (v3.1 exclusive, JPG/PNG recommended).

right_front_image_url string

Optional right-front 45 degree angle view image URL (v3.1 exclusive, JPG/PNG recommended).

generate_type GenerateTypeEnum

Generation task type. Normal: textured model. Geometry: geometry-only white model (no textures). LowPoly/Sketch are not available in v3.1. Default value: "Normal"

Possible enum values: Normal, Geometry

enable_pbr boolean

Enable PBR material generation (metallic, roughness, normal textures). Ignored when generate_type is Geometry.

face_count integer

Target polygon face count. Range: 40,000-1,500,000. Default: 500,000. Default value: 500000

{
  "input_image_url": "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.png",
  "generate_type": "Normal",
  "face_count": 500000
}

Output#

model_glb File* required

Generated 3D object in GLB format.

thumbnail File

Preview thumbnail of the generated model

model_urls ModelUrls* required

URLs for different 3D model formats

seed integer

The seed used for generation

{
  "model_glb": {
    "file_size": 38554640,
    "file_name": "model.glb",
    "content_type": "model/gltf-binary",
    "url": "https://v3b.fal.media/files/b/0a8c3187/jOeZmtBuhdQMkDu65AkdT_model.glb"
  },
  "thumbnail": {
    "file_size": 194908,
    "file_name": "preview.png",
    "content_type": "image/png",
    "url": "https://v3b.fal.media/files/b/0a8c3187/gxidaODj4OvPXruCfrZ-__preview.png"
  },
  "model_urls": {
    "glb": {
      "file_size": 38554640,
      "file_name": "model.glb",
      "content_type": "model/gltf-binary",
      "url": "https://v3b.fal.media/files/b/0a8c3187/jOeZmtBuhdQMkDu65AkdT_model.glb"
    },
    "obj": {
      "file_size": 31447160,
      "file_name": "model.obj",
      "content_type": "model/obj",
      "url": "https://v3b.fal.media/files/b/0a8c3186/no-aBFEDnOuthILfv-wzs_model.obj"
    }
  }
}

Other types#

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

file_data string

File data

ModelUrls#

glb File

GLB format 3D model

fbx File

FBX format 3D model

obj File

OBJ format 3D model

mtl File

MTL material file for OBJ model

texture File

Texture image for the 3D model

usdz File

USDZ format 3D model

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

File#

ModelUrls#

Related Models

Hunyuan 3D Pro Image to 3D Image to 3D

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

File#

ModelUrls#

Related Models