Loading API documentation
Retexture using Meshy N1 (2k only), built for game and low-poly assets.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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/n1/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);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"
});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/n1/retexture", {
input: {
model_url: "https://v3b.fal.media/files/b/penguin/DId89qXLu6BXu09RFAwAV_model.glb"
},
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/n1/retexture", {
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/n1/retexture", {
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);Read more about file handling in our file upload guide.
model_url string* requiredURL 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.
image_style_url stringSingle reference image, treated as the front view. Required if multiview_image_urls is not provided. Supports .jpg, .jpeg, .png, and .webp formats.
1 to 4 reference views of the target texture (first is the front view, order of the rest is irrelevant). Cannot be combined with image_style_url.
enable_original_uv booleanUse 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_safety_checker booleanIf 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",
"enable_original_uv": true,
"enable_safety_checker": true
}Retextured 3D object in GLB format.
Preview thumbnail of the retextured model
URLs for different 3D model formats
Array of texture file objects
text_style_prompt stringThe text prompt used for texturing (if provided)
image_style_url stringThe image URL used for texturing (if provided)
{
"model_glb": {
"file_name": "model.glb",
"content_type": "model/gltf-binary",
"url": "https://v3b.fal.media/files/b/tiger/pU0TtsRTxXM6VnKEYTHSV_model.glb",
"file_size": 4097640
},
"thumbnail": {
"file_name": "preview.png",
"content_type": "image/png",
"url": "https://v3b.fal.media/files/b/lion/jFrzgIJMbaPQi_4HCEa8u_preview.png",
"file_size": 124859
},
"model_urls": {
"fbx": {
"file_name": "model.fbx",
"content_type": "application/octet-stream",
"url": "https://v3b.fal.media/files/b/rabbit/agzKf8N8zeVnteg72NiF4_model.fbx",
"file_size": 4713692
},
"obj": {
"file_name": "model.obj",
"content_type": "model/obj",
"url": "https://v3b.fal.media/files/b/zebra/M5aK_b6vKH7KeGCZoSLq7_model.obj",
"file_size": 2964508
},
"usdz": {
"file_name": "model.usdz",
"content_type": "model/vnd.usdz+zip",
"url": "https://v3b.fal.media/files/b/panda/4ItUhLHiH4foEw30qcWZv_model.usdz",
"file_size": 3886518
},
"glb": {
"file_name": "model.glb",
"content_type": "model/gltf-binary",
"url": "https://v3b.fal.media/files/b/tiger/pU0TtsRTxXM6VnKEYTHSV_model.glb",
"file_size": 4097640
}
},
"texture_urls": [
{
"base_color": {
"file_name": "texture_0.png",
"content_type": "image/png",
"url": "https://v3b.fal.media/files/b/zebra/opBcVy7AK-GOlCTUz-_GZ_texture_0.png",
"file_size": 3455709
}
}
],
"text_style_prompt": "red and black chest"
}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