Meshy 5 Multi | Image to 3D

fal-ai/meshy/v5/multi-image-to-3d

Meshy-5 multi image generates realistic and production ready 3D models from multiple images.

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Convert multiple images to a 3D model using Meshy-5.

Multi-Image to 3D features:

Use 1-4 images of the same object from different angles
Better geometry reconstruction from multiple viewpoints
Only available with Meshy-5 model
Same texture options as single image-to-3D
Processing time: 3-7 minutes

For best results:

Use images of the same object from different angles
Ensure consistent lighting across images
Include front, side, and back views when possible

Note: If more than 4 images are provided, only the first 4 will be used.

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

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/v5/multi-image-to-3d", {
  input: {
    image_urls: ["https://v3.fal.media/files/penguin/X21qtlVMazAtljzRCJD2__image.png", "https://v3b.fal.media/files/b/kangaroo/scq50Bf1PB2NZOW8szphV_image.png", "https://v3.fal.media/files/panda/l7mQrG8plbB42lBNqVjm0_image.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);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API 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.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

Submit a request#

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/v5/multi-image-to-3d", {
  input: {
    image_urls: ["https://v3.fal.media/files/penguin/X21qtlVMazAtljzRCJD2__image.png", "https://v3b.fal.media/files/b/kangaroo/scq50Bf1PB2NZOW8szphV_image.png", "https://v3.fal.media/files/panda/l7mQrG8plbB42lBNqVjm0_image.png"]
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

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/v5/multi-image-to-3d", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

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/v5/multi-image-to-3d", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

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.

Data URI (base64)#

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.

Hosted files (URL)#

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.

Uploading files#

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);

Auto uploads

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.

5. Schema#

Input#

image_urls list<string>* required

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 TopologyEnum

Specify the topology of the generated model. Quad for smooth surfaces, Triangle for detailed geometry. Default value: "triangle"

Possible enum values: quad, triangle

target_polycount integer

Target number of polygons in the generated model Default value: 30000

symmetry_mode SymmetryModeEnum

Controls symmetry behavior during model generation. Default value: "auto"

Possible enum values: off, auto, on

should_remesh boolean

Whether to enable the remesh phase. When false, returns triangular mesh ignoring topology and target_polycount. Default value: true

should_texture boolean

Whether to generate textures. False provides mesh without textures for 5 credits, True adds texture generation for additional 10 credits. Default value: true

enable_pbr boolean

Generate PBR Maps (metallic, roughness, normal) in addition to base color. Requires should_texture to be true.

is_a_t_pose boolean

Whether to generate the model in an A/T pose

texture_prompt string

Text prompt to guide the texturing process. Requires should_texture to be true.

texture_image_url string

2D image to guide the texturing process. Requires should_texture to be true.

enable_safety_checker boolean

If set to true, input data will be checked for safety before processing. Default value: true

{
  "image_urls": [
    "https://v3.fal.media/files/penguin/X21qtlVMazAtljzRCJD2__image.png",
    "https://v3b.fal.media/files/b/kangaroo/scq50Bf1PB2NZOW8szphV_image.png",
    "https://v3.fal.media/files/panda/l7mQrG8plbB42lBNqVjm0_image.png"
  ],
  "topology": "triangle",
  "target_polycount": 30000,
  "symmetry_mode": "auto",
  "should_remesh": true,
  "should_texture": true,
  "enable_safety_checker": true
}

Output#

model_glb File* required

Generated 3D object in GLB format.

thumbnail File

Preview thumbnail of the generated model

model_urls ModelUrls* required

URLs for different 3D model formats

texture_urls list<TextureFiles>

Array of texture file objects

seed integer

The seed used for generation (if available)

{
  "model_glb": {
    "file_size": 8208912,
    "file_name": "model.glb",
    "content_type": "model/gltf-binary",
    "url": "https://v3.fal.media/files/kangaroo/-DnRIqFBx42Q8FBSXh0X6_model.glb"
  },
  "thumbnail": {
    "file_size": 57551,
    "file_name": "preview.png",
    "content_type": "image/png",
    "url": "https://v3.fal.media/files/elephant/g2mExx9qmZHwwyh_C0-b5_preview.png"
  },
  "model_urls": {
    "fbx": {
      "file_size": 4757164,
      "file_name": "model.fbx",
      "content_type": "application/octet-stream",
      "url": "https://v3.fal.media/files/rabbit/5TrUrctZ04hrYkvow7nLV_model.fbx"
    },
    "usdz": {
      "file_size": 8383508,
      "file_name": "model.usdz",
      "content_type": "model/vnd.usdz+zip",
      "url": "https://v3.fal.media/files/zebra/oUPsadbaGNhYCJaUNXUgd_model.usdz"
    },
    "glb": {
      "file_size": 8208912,
      "file_name": "model.glb",
      "content_type": "model/gltf-binary",
      "url": "https://v3.fal.media/files/kangaroo/-DnRIqFBx42Q8FBSXh0X6_model.glb"
    },
    "obj": {
      "file_size": 2788841,
      "file_name": "model.obj",
      "content_type": "text/plain",
      "url": "https://v3.fal.media/files/koala/Zu9AFSHs0e7CybI0NITnS_model.obj"
    }
  },
  "texture_urls": [
    {
      "base_color": {
        "file_size": 3604789,
        "file_name": "texture_0.png",
        "content_type": "image/png",
        "url": "https://v3.fal.media/files/panda/m-G6nzfaIjypRZEKvVjsF_texture_0.png"
      }
    }
  ],
  "seed": 1048721210
}

Other types#

TextureFiles#

base_color File* required

Base color texture

metallic File

Metallic texture (PBR)

normal File

Normal texture (PBR)

roughness File

Roughness texture (PBR)

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

file_data string

File data

ModelUrls#

glb File

GLB format 3D model

fbx File

FBX format 3D model

obj File

OBJ format 3D model

usdz File

USDZ format 3D model

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

TextureFiles#

File#

ModelUrls#

Related Models

Meshy 5 Multi Image to 3D

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

TextureFiles#

File#

ModelUrls#

Related Models