Loading API documentation
Convert multiple images to a 3D model using Meshy-6 Preview.
Multi-Image to 3D features:
For best results:
Note: If more than 4 images are provided, only the first 4 will be used.
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/meshy/v6-preview/multi-image-to-3d", {
input: {
image_urls: ["https://v3b.fal.media/files/b/kangaroo/cPyD3-por0XI7jDa9F9vP_image%20(3).png", "https://v3b.fal.media/files/b/elephant/9sd5JWAOJBcR7G3NMjPVs_image%20(2).png", "https://v3b.fal.media/files/b/tiger/TP4sTzPATX_w1Tn4m6kYM_image%20(1).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"
});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/meshy/v6-preview/multi-image-to-3d", {
input: {
image_urls: ["https://v3b.fal.media/files/b/kangaroo/cPyD3-por0XI7jDa9F9vP_image%20(3).png", "https://v3b.fal.media/files/b/elephant/9sd5JWAOJBcR7G3NMjPVs_image%20(2).png", "https://v3b.fal.media/files/b/tiger/TP4sTzPATX_w1Tn4m6kYM_image%20(1).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("fal-ai/meshy/v6-preview/multi-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("fal-ai/meshy/v6-preview/multi-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);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.
1 to 4 images for 3D model creation. All images should depict the same object from different angles. Supports .jpg, .jpeg, .png formats, and AVIF/HEIF which will be automatically converted. If more than 4 images are provided, only the first 4 will be used.
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 Default value: 30000
symmetry_mode SymmetryModeEnumControls symmetry behavior during model generation. Default value: "auto"
Possible enum values: off, auto, on
should_remesh booleanWhether to enable the remesh phase. When false, returns triangular mesh ignoring topology and target_polycount. Default value: true
should_texture booleanWhether to generate textures. Default value: true
enable_pbr booleanGenerate PBR Maps (metallic, roughness, normal) in addition to base color. Requires should_texture to be true.
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,
texture_prompt stringText prompt to guide the texturing process. Requires should_texture to be true.
texture_image_url string2D image to guide the texturing process. Requires should_texture to be true.
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
{
"image_urls": [
"https://v3b.fal.media/files/b/kangaroo/cPyD3-por0XI7jDa9F9vP_image%20(3).png",
"https://v3b.fal.media/files/b/elephant/9sd5JWAOJBcR7G3NMjPVs_image%20(2).png",
"https://v3b.fal.media/files/b/tiger/TP4sTzPATX_w1Tn4m6kYM_image%20(1).png"
],
"topology": "triangle",
"target_polycount": 30000,
"symmetry_mode": "auto",
"should_remesh": true,
"should_texture": true,
"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 (if available)
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": {
"file_name": "model.glb",
"url": "https://v3b.fal.media/files/b/tiger/62QMEQqZ3pjUds4DfuVtX_model.glb",
"content_type": "model/gltf-binary",
"file_size": 7875308
},
"thumbnail": {
"file_name": "preview.png",
"url": "https://v3b.fal.media/files/b/koala/2NI_hEd7jXzS5rLQhnRga_preview.png",
"content_type": "image/png",
"file_size": 70958
},
"model_urls": {
"obj": {
"file_name": "model.obj",
"url": "https://v3b.fal.media/files/b/koala/xmOnmSeePfuROe3pqHpf0_model.obj",
"content_type": "model/obj",
"file_size": 2761323
},
"glb": {
"file_name": "model.glb",
"url": "https://v3b.fal.media/files/b/tiger/62QMEQqZ3pjUds4DfuVtX_model.glb",
"content_type": "model/gltf-binary",
"file_size": 7875308
},
"usdz": {
"file_name": "model.usdz",
"url": "https://v3b.fal.media/files/b/panda/fSGLGmtgzUjhepklN06Zw_model.usdz",
"content_type": "model/vnd.usdz+zip",
"file_size": 8631497
},
"fbx": {
"file_name": "model.fbx",
"url": "https://v3b.fal.media/files/b/koala/R7vPBgkecVvcnbNpRAy9x_model.fbx",
"content_type": "application/octet-stream",
"file_size": 5574540
}
},
"texture_urls": [
{
"base_color": {
"file_name": "texture_0.png",
"url": "https://v3b.fal.media/files/b/panda/OVrRor7IgeNK9w2i5-NDf_texture_0.png",
"content_type": "image/png",
"file_size": 4464364
}
}
],
"seed": 783032043
}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
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