Loading API documentation
Generate a 3D model from a single image.
Uses the Sparc3D/Ultra3D-based HItem3D models. Set enable_texture=false for a geometry-only mesh (cheaper), and pick a model/resolution tier to trade off quality and cost.
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/image-to-3d", {
input: {
image_url: "https://storage.googleapis.com/falserverless/example_inputs/dog.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"
});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/image-to-3d", {
input: {
image_url: "https://storage.googleapis.com/falserverless/example_inputs/dog.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("hitem3d/hi3d/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("hitem3d/hi3d/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);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 ModelEnumModel version used for generation. 'hitem3d*' are the general models; 'scene-portrait*' are tuned for portraits/characters. Default value: "hitem3dv2.1"
Possible enum values: hitem3dv1.5, hitem3dv2.0, hitem3dv2.1, scene-portraitv1.5, scene-portraitv2.0, scene-portraitv2.1
resolution EnumGeneration resolution. Supported values depend on the model: v1.5/v2.0 accept 512, 1024, 1536 and 1536pro; v2.1 accepts 1536fast and 1536pro; scene-portraitv1.5 accepts 1536; scene-portraitv2.0 accepts 1536pro; scene-portraitv2.1 accepts 1536profast and 1536pro. Defaults to the model's recommended resolution (1024 for v1.5/v2.0, the fast tier otherwise).
Possible enum values: 512, 1024, 1536, 1536pro, 1536fast, 1536profast
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 of the generated model. When unset, the partner picks the recommended count for the resolution (e.g. 500k for 512, 1M for 1024, 2M for 1536).
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
image_url string* requiredURL of the input image. PNG, JPEG and WebP formats are supported, up to 20MB.
{
"model": "hitem3dv2.1",
"enable_texture": true,
"enable_pbr": true,
"export_format": "glb",
"enable_safety_checker": true,
"image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png"
}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.