Loading API documentation
Generate a 3D model from text using the latest Meshy-7.1 model.
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("meshy/v7.1/text-to-3d", {
input: {
prompt: "A rustic, antique wooden treasure chest with a curved, domed lid, constructed from weathered, dark brown planks exhibiting prominent wood grain and subtle distress. It's heavily reinforced with broad, dark grey, oxidized metal bands secured by numerous circular rivets. Ornate, dark iron decorative elements featuring swirling foliate patterns and dragon motifs adorn the corners and lid. A prominent, circular, intricately carved metal lock plate with a central keyhole dominates the front, flanked by two large, dark metallic pull rings."
},
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("meshy/v7.1/text-to-3d", {
input: {
prompt: "A rustic, antique wooden treasure chest with a curved, domed lid, constructed from weathered, dark brown planks exhibiting prominent wood grain and subtle distress. It's heavily reinforced with broad, dark grey, oxidized metal bands secured by numerous circular rivets. Ornate, dark iron decorative elements featuring swirling foliate patterns and dragon motifs adorn the corners and lid. A prominent, circular, intricately carved metal lock plate with a central keyhole dominates the front, flanked by two large, dark metallic pull rings."
},
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("meshy/v7.1/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("meshy/v7.1/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* requiredDescribe what kind of object the 3D model is. Maximum 600 characters.
mode ModeEnumGeneration mode. 'preview' returns untextured geometry only, 'full' returns textured model (preview + refine). Default value: "full"
Possible enum values: preview, full
seed integerSeed for reproducible results. Same prompt and seed usually generate the same result.
model_type ModelTypeEnumType of 3D mesh generation. 'standard' produces a regular high-detail mesh; 'lowpoly' produces a low-poly mesh optimized for cleaner polygons; 'smart-topology' (Smart Topology T2.5) and 'smart-topology-t2' (Smart Topology T2) produce clean, triangle-only meshes with natively separated parts on the geometry (preview) step — T2.5 has sharper detail, T2 is faster. When set to 'lowpoly', the remesh controls (topology, target_polycount, should_remesh) are ignored by Meshy. Default value: "standard"
Possible enum values: standard, lowpoly, smart-topology, smart-topology-t2
topology TopologyEnumSpecify the topology of the generated model. Quad for smooth surfaces, Triangle for detailed geometry. Default value: "triangle"
Possible enum values: quad, triangle
target_polycount integerTarget number of polygons in the generated model. When model_type is a smart topology option and this is left unset, that model's default is used instead (15,000 for T2.5, 4,000 for T2); the maximum is 30,000 for T2.5 and 15,000 for T2. Default value: 30000
should_remesh booleanWhether to enable the remesh phase. When false, returns unprocessed triangular mesh. Default value: true
symmetry_mode SymmetryModeEnumControls symmetry behavior during model generation. Default value: "auto"
Possible enum values: off, auto, on
enable_pbr booleanGenerate PBR Maps (metallic, roughness, normal) in addition to base color.
pose_mode PoseModeEnumPose mode for the generated model. 'a-pose' generates an A-pose, 't-pose' generates a T-pose, empty string for no specific pose. Default value: ""
Possible enum values: a-pose, t-pose,
enable_prompt_expansion booleanWhether to enable prompt expansion. This will use a large language model to expand the prompt with additional details while maintaining the original meaning.
texture_prompt stringAdditional text prompt to guide the texturing process (only used in 'full' mode)
texture_image_url string2D image to guide the texturing process (only used in 'full' mode)
enable_rigging booleanAutomatically rig the generated model as a humanoid character. Includes basic walking and running animations. Best results with humanoid characters that have clearly defined limbs.
rigging_height_meters floatApproximate height of the character in meters. Only used when enable_rigging is true. Default value: 1.7
enable_animation booleanApply an animation preset to the rigged model. Requires enable_rigging to be true.
animation_action_id integerAnimation preset ID from Meshy's library. Only used when enable_animation is true; in that case it must be in [0, 696] (0 is the "Idle" preset) and is otherwise rejected with a 422. See https://docs.meshy.ai/en/api/animation-library for available action IDs. Default value: 92
enable_safety_checker booleanIf set to true, input data will be checked for safety before processing. Default value: true
geometry_resolution EnumGeometry resolution. 4k is only available with Meshy-7.1.
Possible enum values: standard, 2k, 4k
{
"prompt": "A rustic, antique wooden treasure chest with a curved, domed lid, constructed from weathered, dark brown planks exhibiting prominent wood grain and subtle distress. It's heavily reinforced with broad, dark grey, oxidized metal bands secured by numerous circular rivets. Ornate, dark iron decorative elements featuring swirling foliate patterns and dragon motifs adorn the corners and lid. A prominent, circular, intricately carved metal lock plate with a central keyhole dominates the front, flanked by two large, dark metallic pull rings.",
"mode": "full",
"model_type": "standard",
"topology": "triangle",
"target_polycount": 30000,
"should_remesh": true,
"symmetry_mode": "auto",
"rigging_height_meters": 1.7,
"animation_action_id": 92,
"enable_safety_checker": true
}Animated 3D model in GLB format. Only present when enable_animation is true.
Animated 3D model in FBX format. Only present when enable_animation is true.
Generated 3D object in GLB format.
Preview thumbnail of the generated model
URLs for different 3D model formats
Array of texture file objects
seed integerThe seed used for generation
prompt string* requiredThe text prompt used for generation
actual_prompt stringThe actual prompt used if prompt expansion was enabled
Rigged character in GLB format. Only present when enable_rigging is true.
Rigged character in FBX format. Only present when enable_rigging is true.
Basic walking and running animations. Only present when enable_rigging is true.
rig_task_id stringRigging task ID. Only present when enable_rigging is true.
{
"model_glb": {
"url": "https://v3b.fal.media/files/b/penguin/DId89qXLu6BXu09RFAwAV_model.glb",
"content_type": "model/gltf-binary",
"file_size": 9314028,
"file_name": "model.glb"
},
"thumbnail": {
"url": "https://v3b.fal.media/files/b/koala/6LJISu4ilkZXcdOETwl_d_preview.png",
"content_type": "image/png",
"file_size": 173792,
"file_name": "preview.png"
},
"model_urls": {
"fbx": {
"url": "https://v3b.fal.media/files/b/kangaroo/7nUUw5dHN9a0DKlOpAKbP_model.fbx",
"content_type": "application/octet-stream",
"file_size": 5444380,
"file_name": "model.fbx"
},
"glb": {
"url": "https://v3b.fal.media/files/b/penguin/DId89qXLu6BXu09RFAwAV_model.glb",
"content_type": "model/gltf-binary",
"file_size": 9314028,
"file_name": "model.glb"
},
"usdz": {
"url": "https://v3b.fal.media/files/b/panda/XcC-mIJywUvH7coyrzENU_model.usdz",
"content_type": "model/vnd.usdz+zip",
"file_size": 9834246,
"file_name": "model.usdz"
},
"obj": {
"url": "https://v3b.fal.media/files/b/monkey/cCNMHqUbKSNtDN1iGmiYm_model.obj",
"content_type": "model/obj",
"file_size": 2755145,
"file_name": "model.obj"
}
},
"texture_urls": [
{
"base_color": {
"url": "https://v3b.fal.media/files/b/panda/DoPKAuZY0tTjnr6C9ee-Q_texture_0.png",
"content_type": "image/png",
"file_size": 4254502,
"file_name": "texture_0.png"
}
}
],
"seed": 4002110719,
"prompt": "A rustic, antique wooden treasure chest with a curved, domed lid, constructed from weathered, dark brown planks exhibiting prominent wood grain and subtle distress. It's heavily reinforced with broad, dark grey, oxidized metal bands secured by numerous circular rivets. Ornate, dark iron decorative elements featuring swirling foliate patterns and dragon motifs adorn the corners and lid. A prominent, circular, intricately carved metal lock plate with a central keyhole dominates the front, flanked by two large, dark metallic pull rings."
}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
USDZ format 3D model
Blender format 3D model
STL format 3D model
Walking animation in GLB format
Walking animation in FBX format
Walking armature only in GLB format
Running animation in GLB format
Running animation in FBX format
Running armature only in GLB format