Loading API documentation
H31 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("tripo3d/h3.1/image-to-3d", {
input: {
image_url: "https://v3b.fal.media/files/b/zebra/3osHJDI8IZ2wl6sGtEUeB_image.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("tripo3d/h3.1/image-to-3d", {
input: {
image_url: "https://v3b.fal.media/files/b/zebra/3osHJDI8IZ2wl6sGtEUeB_image.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("tripo3d/h3.1/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("tripo3d/h3.1/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.
image_url string* requiredURL of the input image for 3D model creation.
face_limit integerTarget number of faces for the generated mesh. If not set, the model adaptively determines the count.
texture booleanWhether to generate textures for the model. Default value: true
pbr booleanWhether to generate PBR (Physically Based Rendering) materials. If true, texture is also enabled. Default value: true
model_seed integerSeed for geometry generation reproducibility.
texture_seed integerSeed for texture generation reproducibility.
texture_quality TextureQualityEnumQuality level for textures. 'detailed' produces higher-resolution textures. Default value: "standard"
Possible enum values: standard, detailed
geometry_quality GeometryQualityEnumQuality level for geometry. Default value: "standard"
Possible enum values: standard, detailed
texture_alignment TextureAlignmentEnumHow textures are aligned. 'original_image' aligns to input image, 'geometry' aligns to generated geometry. Default value: "original_image"
Possible enum values: original_image, geometry
auto_size booleanAuto-scale the model to real-world dimensions (meters).
orientation OrientationEnumModel orientation. 'align_image' auto-rotates to match the input image. Default value: "default"
Possible enum values: default, align_image
quad booleanGenerate quad (4-sided) mesh topology instead of triangles. When Tripo emits FBX bytes for quad output, the returned model file is FBX.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"image_url": "https://v3b.fal.media/files/b/zebra/3osHJDI8IZ2wl6sGtEUeB_image.png",
"texture": true,
"pbr": true,
"texture_quality": "standard",
"geometry_quality": "standard",
"texture_alignment": "original_image",
"orientation": "default",
"enable_safety_checker": true
}Generated 3D model file. May be GLB or FBX depending on Tripo output.
URLs for different 3D model variants.
Preview render of the generated 3D model.
task_id stringTripo task ID for a generated model. Pass this to rig or rig-check to use the model without uploading it again.
{
"model_mesh": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
},
"model_urls": {}
}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.