Log-inSign-up

Hunyuan3d V3 Image to 3D

fal-ai/hunyuan3d-v3/sketch-to-3d
Create your imagined 3D models with just text. Production-ready, export-ready professional assets with realistic lighting and materials in minutes.
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

About

Sketch 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

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/hunyuan3d-v3/sketch-to-3d", {
  input: {
    input_image_url: "https://v3b.fal.media/files/b/0a86888c/Zlw8twOa43SKkCXmTdw3-.png",
    prompt: "orange cat"
  },
  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"
});

3. Queue#

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/hunyuan3d-v3/sketch-to-3d", {
  input: {
    input_image_url: "https://v3b.fal.media/files/b/0a86888c/Zlw8twOa43SKkCXmTdw3-.png",
    prompt: "orange cat"
  },
  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/hunyuan3d-v3/sketch-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/hunyuan3d-v3/sketch-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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

input_image_url string* required

URL of sketch or line art image to transform into a 3D model. Image resolution must be between 128x128 and 5000x5000 pixels.

prompt string* required

Text prompt describing the 3D content attributes such as color, category, and material.

enable_pbr boolean

Whether to enable PBR material generation.

face_count integer

Target face count. Range: 40000-1500000 Default value: 500000

{
  "input_image_url": "https://v3b.fal.media/files/b/0a86888c/Zlw8twOa43SKkCXmTdw3-.png",
  "prompt": "orange cat",
  "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": 30655724,
    "file_name": "model.glb",
    "content_type": "model/gltf-binary",
    "url": "https://v3b.fal.media/files/b/0a8688bb/vd2SlBP92cZls3zG5EPbg_model.glb"
  },
  "thumbnail": {
    "file_size": 68478,
    "file_name": "preview.png",
    "content_type": "image/png",
    "url": "https://v3b.fal.media/files/b/0a8688bb/ZkMb4jHnb5QRNYp4SxkEA_preview.png"
  },
  "model_urls": {
    "glb": {
      "file_size": 30655724,
      "file_name": "model.glb",
      "content_type": "model/gltf-binary",
      "url": "https://v3b.fal.media/files/b/0a8688bb/vd2SlBP92cZls3zG5EPbg_model.glb"
    },
    "obj": {
      "file_size": 23418473,
      "file_name": "model.obj",
      "content_type": "text/plain",
      "url": "https://v3b.fal.media/files/b/0a8688bb/QNik1DVxzvj23YEF3vhs__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

usdz File

USDZ format 3D model

Related Models