fal-ai/meshy/v6/image-to-3d

Meshy-6 is the latest model from Meshy. It generates realistic and production ready 3D models.

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Convert an image to a 3D model using Meshy-6 Preview.

Meshy-6 Preview features:

Latest model with best quality
Most accurate geometry reconstruction
Superior texture quality
Processing time: 5-10 minutes
Best for high-quality results

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/v6/image-to-3d", {
  input: {
    image_url: "https://v3b.fal.media/files/b/zebra/3osHJDI8IZ2wl6sGtEUeB_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/v6/image-to-3d", {
  input: {
    image_url: "https://v3b.fal.media/files/b/zebra/3osHJDI8IZ2wl6sGtEUeB_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/v6/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/v6/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_url string* required

Image URL or base64 data URI for 3D model creation. Supports .jpg, .jpeg, and .png formats. Also supports AVIF and HEIF formats which will be automatically converted.

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. Off disables symmetry, Auto determines it automatically, On enforces symmetry. Default value: "auto"

Possible enum values: off, auto, on

should_remesh boolean

Whether to enable the remesh phase Default value: true

should_texture boolean

Whether to generate textures Default value: true

enable_pbr boolean

Generate PBR Maps (metallic, roughness, normal) in addition to base color

pose_mode PoseModeEnum

Pose 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 string

Text prompt to guide the texturing process

texture_image_url string

2D image to guide the texturing process

enable_rigging boolean

Automatically 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 float

Approximate height of the character in meters. Only used when enable_rigging is true. Default value: 1.7

enable_animation boolean

Apply an animation preset to the rigged model. Requires enable_rigging to be true.

animation_action_id integer

Animation preset ID from Meshy's library (500+ presets). Only used when enable_animation is true. See https://docs.meshy.ai/en/api/animation-library for available action IDs. Default value: 1001

enable_safety_checker boolean

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

{
  "image_url": "https://v3b.fal.media/files/b/zebra/3osHJDI8IZ2wl6sGtEUeB_image.png",
  "topology": "triangle",
  "target_polycount": 30000,
  "symmetry_mode": "auto",
  "should_remesh": true,
  "should_texture": true,
  "rigging_height_meters": 1.7,
  "animation_action_id": 1001,
  "enable_safety_checker": true
}

Output#

animation_glb File

Animated 3D model in GLB format. Only present when enable_animation is true.

animation_fbx File

Animated 3D model in FBX format. Only present when enable_animation is true.

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, matching Meshy API structure

seed integer

The seed used for generation (if available)

rigged_character_glb File

Rigged character in GLB format. Only present when enable_rigging is true.

rigged_character_fbx File

Rigged character in FBX format. Only present when enable_rigging is true.

basic_animations BasicAnimations

Basic walking and running animations. Only present when enable_rigging is true.

rig_task_id string

Rigging task ID. Only present when enable_rigging is true.

{
  "model_glb": {
    "file_size": 9242744,
    "file_name": "model.glb",
    "content_type": "model/gltf-binary",
    "url": "https://v3b.fal.media/files/b/zebra/OXF1e1bO3JddPTaugv0eL_model.glb"
  },
  "thumbnail": {
    "file_size": 54279,
    "file_name": "preview.png",
    "content_type": "image/png",
    "url": "https://v3b.fal.media/files/b/penguin/rfnS6ClmeEWgDXp_oD5tN_preview.png"
  },
  "model_urls": {
    "fbx": {
      "file_size": 5427052,
      "file_name": "model.fbx",
      "content_type": "application/octet-stream",
      "url": "https://v3b.fal.media/files/b/kangaroo/4Q2qdpTvfLVdzAKH1-72v_model.fbx"
    },
    "usdz": {
      "file_size": 9991969,
      "file_name": "model.usdz",
      "content_type": "model/vnd.usdz+zip",
      "url": "https://v3b.fal.media/files/b/lion/RgJG9EBQ_GAHMVWV3wCis_model.usdz"
    },
    "obj": {
      "file_size": 2744413,
      "file_name": "model.obj",
      "content_type": "text/plain",
      "url": "https://v3b.fal.media/files/b/koala/_Vg0d084-hd3EdpIJDf7U_model.obj"
    },
    "glb": {
      "file_size": 9242744,
      "file_name": "model.glb",
      "content_type": "model/gltf-binary",
      "url": "https://v3b.fal.media/files/b/zebra/OXF1e1bO3JddPTaugv0eL_model.glb"
    }
  },
  "texture_urls": [
    {
      "base_color": {
        "file_size": 4328755,
        "file_name": "texture_0.png",
        "content_type": "image/png",
        "url": "https://v3b.fal.media/files/b/tiger/NkgxcEom_42V4_8UUXiRR_texture_0.png"
      }
    }
  ],
  "seed": 2009275957
}

Other types#

BasicAnimations#

walking_glb File

Walking animation in GLB format

walking_fbx File

Walking animation in FBX format

walking_armature_glb File

Walking armature only in GLB format

running_glb File

Running animation in GLB format

running_fbx File

Running animation in FBX format

running_armature_glb File

Running armature only in GLB format

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.

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

blend File

Blender format 3D model

stl File

STL format 3D model

TextureFiles#

base_color File* required

Base color texture

metallic File

Metallic texture (PBR)

normal File

Normal texture (PBR)

roughness File

Roughness texture (PBR)

fal-ai/meshy/v6/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#

BasicAnimations#

File#

ModelUrls#

TextureFiles#

Related Models