Loading API documentation
Pro Image To 3D
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});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",
});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,
});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);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.
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.
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.
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.
input_image_url string* requiredFront view image URL. Resolution: 128-5000px, max 8MB, formats: JPG/PNG/WEBP. Tips: simple background, single object, object >50% of frame.
back_image_url stringOptional back/rear view image URL (JPG/PNG recommended).
left_image_url stringOptional left side view image URL (JPG/PNG recommended).
right_image_url stringOptional right side view image URL (JPG/PNG recommended).
top_image_url stringOptional top view image URL (v3.1 exclusive, JPG/PNG recommended).
bottom_image_url stringOptional bottom view image URL (v3.1 exclusive, JPG/PNG recommended).
left_front_image_url stringOptional left-front 45 degree angle view image URL (v3.1 exclusive, JPG/PNG recommended).
right_front_image_url stringOptional right-front 45 degree angle view image URL (v3.1 exclusive, JPG/PNG recommended).
generate_type GenerateTypeEnumGeneration 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 booleanEnable PBR material generation (metallic, roughness, normal textures). Ignored when generate_type is Geometry.
face_count integerTarget 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
}Generated 3D object in GLB format.
Preview thumbnail of the generated model
URLs for different 3D model formats
seed integerThe 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"
}
}
}GLB format 3D model
FBX format 3D model
OBJ format 3D model
MTL material file for OBJ model
Texture image for the 3D model
USDZ format 3D model
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.