Loading API documentation
Generate a Hi3D v3.0 model from up to four view images.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set 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("hitem3d/hi3d/v3.0/multi-view-to-3d", {
input: {},
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"
});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.
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("hitem3d/hi3d/v3.0/multi-view-to-3d", {
input: {},
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("hitem3d/hi3d/v3.0/multi-view-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("hitem3d/hi3d/v3.0/multi-view-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);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.
model stringHi3D v3.0 model version used by this endpoint. Default value: "hi3dv3.0"
resolution ResolutionEnumGeneration resolution. 2048quality is the faster default; 2048master provides the highest quality. Default value: "2048quality"
Possible enum values: 2048quality, 2048master
enable_texture booleanWhether to generate textures in addition to geometry. When false, only the geometry mesh is generated (and billed). Default value: true
enable_pbr booleanGenerate PBR material maps together with the texture. Only supported (and billed) for v2.0/v2.1 and v3.0 models when enable_texture is true; ignored otherwise. Default value: true
face_count integerTarget face count. The partner recommends 2,000,000 for 2048quality and 5,000,000 for 2048master.
export_format ExportFormatEnumFile format of the generated model. Default value: "glb"
Possible enum values: glb, obj, stl, fbx, usdz
enable_safety_checker booleanIf set to true, input images are checked for safety before processing. Default value: true
front_image_url stringURL of the front view image (PNG/JPEG/WebP, up to 20MB).
back_image_url stringURL of the back view image (PNG/JPEG/WebP, up to 20MB).
left_image_url stringURL of the left view image (PNG/JPEG/WebP, up to 20MB).
right_image_url stringURL of the right view image (PNG/JPEG/WebP, up to 20MB).
shading floatDe-shading strength. Default value: 0.5
{
"model": "hi3dv3.0",
"resolution": "2048quality",
"enable_texture": true,
"enable_pbr": true,
"export_format": "glb",
"enable_safety_checker": true,
"front_image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png",
"shading": 0.5
}Generated 3D model file.
Preview image of the generated model, when available.
{
"model_mesh": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
}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.