Meshy 5 Retexture | 3D to 3D

fal-ai/meshy/v5/retexture

Meshy-5 retexture applies new, high-quality textures to existing 3D models using either text prompts or reference images. It supports PBR material generation for realistic, production-ready results.

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Retexture a 3D model using Meshy-5.

Retexturing features:

Apply texture styles to existing 3D models
Supports text-based and image-based style guidance
Best for enhancing existing models with new textures
Processing time: 3-5 minutes

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/retexture", {
  input: {
    model_url: "https://v3b.fal.media/files/b/penguin/DId89qXLu6BXu09RFAwAV_model.glb"
  },
  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/retexture", {
  input: {
    model_url: "https://v3b.fal.media/files/b/penguin/DId89qXLu6BXu09RFAwAV_model.glb"
  },
  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/retexture", {
  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/retexture", {
  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#

model_url string* required

URL or base64 data URI of a 3D model to texture. Supports .glb, .gltf, .obj, .fbx, .stl formats. Can be a publicly accessible URL or data URI with MIME type application/octet-stream.

text_style_prompt string

Describe your desired texture style using text. Maximum 600 characters. Required if image_style_url is not provided.

image_style_url string

2D image to guide the texturing process. Supports .jpg, .jpeg, and .png formats. Required if text_style_prompt is not provided. If both are provided, image_style_url takes precedence.

enable_original_uv boolean

Use the original UV mapping of the model instead of generating new UVs. If the model has no original UV, output quality may be reduced. Default value: true

enable_pbr boolean

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

enable_safety_checker boolean

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

{
  "model_url": "https://v3b.fal.media/files/b/penguin/DId89qXLu6BXu09RFAwAV_model.glb",
  "text_style_prompt": "red and black chest",
  "enable_original_uv": true,
  "enable_safety_checker": true
}

Output#

model_glb File* required

Retextured 3D object in GLB format.

thumbnail File

Preview thumbnail of the retextured model

model_urls ModelUrls* required

URLs for different 3D model formats

texture_urls list<TextureFiles>

Array of texture file objects

text_style_prompt string

The text prompt used for texturing (if provided)

image_style_url string

The image URL used for texturing (if provided)

{
  "model_glb": {
    "file_size": 4097640,
    "file_name": "model.glb",
    "content_type": "model/gltf-binary",
    "url": "https://v3b.fal.media/files/b/tiger/pU0TtsRTxXM6VnKEYTHSV_model.glb"
  },
  "thumbnail": {
    "file_size": 124859,
    "file_name": "preview.png",
    "content_type": "image/png",
    "url": "https://v3b.fal.media/files/b/lion/jFrzgIJMbaPQi_4HCEa8u_preview.png"
  },
  "model_urls": {
    "fbx": {
      "file_size": 4713692,
      "file_name": "model.fbx",
      "content_type": "application/octet-stream",
      "url": "https://v3b.fal.media/files/b/rabbit/agzKf8N8zeVnteg72NiF4_model.fbx"
    },
    "usdz": {
      "file_size": 3886518,
      "file_name": "model.usdz",
      "content_type": "model/vnd.usdz+zip",
      "url": "https://v3b.fal.media/files/b/panda/4ItUhLHiH4foEw30qcWZv_model.usdz"
    },
    "glb": {
      "file_size": 4097640,
      "file_name": "model.glb",
      "content_type": "model/gltf-binary",
      "url": "https://v3b.fal.media/files/b/tiger/pU0TtsRTxXM6VnKEYTHSV_model.glb"
    },
    "obj": {
      "file_size": 2964508,
      "file_name": "model.obj",
      "content_type": "text/plain",
      "url": "https://v3b.fal.media/files/b/zebra/M5aK_b6vKH7KeGCZoSLq7_model.obj"
    }
  },
  "texture_urls": [
    {
      "base_color": {
        "file_size": 3455709,
        "file_name": "texture_0.png",
        "content_type": "image/png",
        "url": "https://v3b.fal.media/files/b/zebra/opBcVy7AK-GOlCTUz-_GZ_texture_0.png"
      }
    }
  ],
  "text_style_prompt": "red and black chest"
}

Other types#

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

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)

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#

File#

ModelUrls#

TextureFiles#

Related Models

Meshy 5 Retexture 3D 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#

File#

ModelUrls#

TextureFiles#

Related Models