Loading API documentation
P2 Text To 3D
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("tripo3d/p2/text-to-3d", {
input: {
prompt: "A low-poly wooden chair"
},
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("tripo3d/p2/text-to-3d", {
input: {
prompt: "A low-poly wooden chair"
},
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/p2/text-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/p2/text-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.
prompt string* requiredText description of the 3D object to generate. Maximum 1024 characters.
negative_prompt stringText describing features to avoid in the generated model.
image_seed integerSeed for the internal text-to-image step.
model_seed integerSeed for geometry generation reproducibility.
face_limit integerMaximum number of faces for the generated mesh. Quad meshes support up to 25,000 faces.
texture booleanWhether to generate textures for the model. Default value: true
pbr booleanWhether to generate PBR material maps. Enabling PBR also enables textures. Default value: true
texture_seed integerSeed for texture generation reproducibility.
texture_quality TextureQualityEnumTexture quality level. Default value: "standard"
Possible enum values: fast, standard, detailed, extreme
texture_version EnumTexture model version. The fast quality requires v3.5-20260815.
Possible enum values: v3.5-20260815, v3.0-20250812, v2.5-20250123
delight booleanRemove baked-in lighting before texturing with v3.5-20260815. Default value: true
auto_size booleanAuto-scale the model to real-world dimensions in meters.
export_uv booleanWhether to generate UV coordinates for the model. Default value: true
export_orientation EnumOptional forward axis for the exported model.
Possible enum values: +x, -x, -y, +y
quad booleanGenerate quad mesh topology instead of triangles.
enable_safety_checker booleanAuthorized callers may set false to request relaxed screening. Default value: true
{
"prompt": "A low-poly wooden chair",
"texture": true,
"pbr": true,
"texture_quality": "standard",
"delight": true,
"export_uv": true,
"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.