Loading API documentation
Reconstruct one or more 3D objects from image and masks.
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/sam-3/3d-objects", {
input: {
image_url: "https://v3b.fal.media/files/b/0a8439e5/TyAmfW5w_sqRXRzWVBGsW_car.jpeg"
},
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/sam-3/3d-objects", {
input: {
image_url: "https://v3b.fal.media/files/b/0a8439e5/TyAmfW5w_sqRXRzWVBGsW_car.jpeg"
},
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/sam-3/3d-objects", {
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/sam-3/3d-objects", {
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.
enable_safety_checker booleanDefault value: true
image_url string* requiredURL of the image to reconstruct in 3D
Optional list of mask URLs (one per object). If not provided, use prompt/point_prompts/box_prompts to auto-segment, or entire image will be used.
prompt stringText prompt for auto-segmentation when no masks provided (e.g., 'chair', 'lamp') Default value: "car"
Point prompts for auto-segmentation when no masks provided
Box prompts for auto-segmentation when no masks provided. Multiple boxes supported - each produces a separate object mask for 3D reconstruction.
seed integerRandom seed for reproducibility
pointmap_url stringOptional URL to external pointmap/depth data (NPY or NPZ format) for improved 3D reconstruction depth estimation
detection_threshold floatDetection confidence threshold (0.1-1.0). Lower = more detections but less precise. If not set, uses the model's default.
export_textured_glb booleanIf True, exports GLB with baked texture and UVs instead of vertex colors.
{
"enable_safety_checker": true,
"image_url": "https://v3b.fal.media/files/b/0a8439e5/TyAmfW5w_sqRXRzWVBGsW_car.jpeg",
"prompt": "car",
"point_prompts": [],
"box_prompts": []
}Gaussian splat file (.ply) - combined scene splat for multi-object, single splat otherwise
3D mesh in GLB format - combined scene for multi-object, single mesh otherwise
Per-object metadata (rotation/translation/scale)
Individual Gaussian splat files per object (only for multi-object scenes)
Individual GLB mesh files per object (only for multi-object scenes)
Zip bundle containing all artifacts and metadata
{
"gaussian_splat": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
},
"metadata": [
{}
],
"individual_splats": [
{
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019
}
],
"individual_glbs": [
{
"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.
object_index integer* requiredIndex of the object in the scene
Scale factors [sx, sy, sz]
Rotation quaternion [x, y, z, w]
Translation [tx, ty, tz]
Camera pose matrix
x_min integerX Min Coordinate of the box
y_min integerY Min Coordinate of the box
x_max integerX Max Coordinate of the box
y_max integerY Max Coordinate of the box
object_id integerOptional object identifier. Boxes sharing an object id refine the same object.
x integerX Coordinate of the prompt
y integerY Coordinate of the prompt
label Enum1 for foreground, 0 for background
Possible enum values: 0, 1
object_id integerOptional object identifier. Prompts sharing an object id refine the same object. When a text prompt is also given, the id selects which detected object the points refine.