Loading API documentation
Rapid 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("fal-ai/hunyuan-3d/v3.1/rapid/text-to-3d", {
input: {
prompt: "A rustic wooden treasure chest with metal bands and ornate lock"
},
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("fal-ai/hunyuan-3d/v3.1/rapid/text-to-3d", {
input: {
prompt: "A rustic wooden treasure chest with metal bands and ornate lock"
},
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/hunyuan-3d/v3.1/rapid/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("fal-ai/hunyuan-3d/v3.1/rapid/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 content to generate. Max 200 UTF-8 characters.
enable_pbr booleanEnable PBR material generation (metallic, roughness, normal textures). Does not take effect when enable_geometry is True.
enable_geometry booleanGenerate geometry-only white model without textures. When enabled, enable_pbr is ignored and OBJ is not supported (default output is GLB).
{
"prompt": "A rustic wooden treasure chest with metal bands and ornate lock"
}Generated 3D model in OBJ format.
MTL material file for the OBJ model.
Texture image for the 3D model.
Preview thumbnail of the generated model
URLs for different 3D model formats.
{
"model_obj": {
"file_name": "0f7f7a1ac578c80d4397a7f2b69b40ff.obj",
"content_type": "model/obj",
"file_size": 5306476,
"url": "https://v3b.fal.media/files/b/0a8c44d5/2W2KRP1DM_-4qI8F_n05b_0f7f7a1ac578c80d4397a7f2b69b40ff.obj"
},
"material_mtl": {
"file_name": "material.mtl",
"content_type": "text/plain",
"file_size": 157,
"url": "https://v3b.fal.media/files/b/0a8c44d5/EHzTxJtHpdIliaMNnEke-_material.mtl"
},
"texture": {
"file_name": "material.png",
"content_type": "image/png",
"file_size": 5915609,
"url": "https://v3b.fal.media/files/b/0a8c44d5/T0q-P0aqXVG_y7jff-XTa_material.png"
},
"thumbnail": {
"file_name": "preview.png",
"content_type": "image/png",
"file_size": 281374,
"url": "https://v3b.fal.media/files/b/0a8c44d6/D9_IYgpugP0deXvSwBC2J_preview.png"
},
"model_urls": {
"mtl": {
"file_name": "material.mtl",
"content_type": "text/plain",
"file_size": 157,
"url": "https://v3b.fal.media/files/b/0a8c44d5/EHzTxJtHpdIliaMNnEke-_material.mtl"
},
"obj": {
"file_name": "0f7f7a1ac578c80d4397a7f2b69b40ff.obj",
"content_type": "model/obj",
"file_size": 5306476,
"url": "https://v3b.fal.media/files/b/0a8c44d5/2W2KRP1DM_-4qI8F_n05b_0f7f7a1ac578c80d4397a7f2b69b40ff.obj"
},
"texture": {
"file_name": "material.png",
"content_type": "image/png",
"file_size": 5915609,
"url": "https://v3b.fal.media/files/b/0a8c44d5/T0q-P0aqXVG_y7jff-XTa_material.png"
}
}
}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.
GLB format 3D model
FBX format 3D model
OBJ format 3D model
MTL material file for OBJ model
Texture image for the 3D model
USDZ format 3D model