DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Trellis Image to 3D

fal-ai/trellis
Generate 3D models from your images using Trellis. A native 3D generative model enabling versatile and high-quality 3D asset creation.
Inference
Commercial use
PlaygroundAPI

About

Generate

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

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/trellis", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/web-examples/rodin3d/warriorwoman.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"
});

3. Queue#

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/trellis", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/web-examples/rodin3d/warriorwoman.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/trellis", {
  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/trellis", {
  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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

image_url string* required

URL of the input image to convert to 3D

seed integer

Random seed for reproducibility

ss_guidance_strength float

Guidance strength for sparse structure generation Default value: 7.5

ss_sampling_steps integer

Sampling steps for sparse structure generation Default value: 12

slat_guidance_strength float

Guidance strength for structured latent generation Default value: 3

slat_sampling_steps integer

Sampling steps for structured latent generation Default value: 12

mesh_simplify float

Mesh simplification factor Default value: 0.95

texture_size TextureSizeEnum

Texture resolution Default value: "1024"

Possible enum values: 512, 1024, 2048

{
  "image_url": "https://storage.googleapis.com/falserverless/web-examples/rodin3d/warriorwoman.png",
  "ss_guidance_strength": 7.5,
  "ss_sampling_steps": 12,
  "slat_guidance_strength": 3,
  "slat_sampling_steps": 12,
  "mesh_simplify": 0.95,
  "texture_size": 1024
}

Output#

model_mesh File* required

Generated 3D mesh file

timings Timings* required

Processing timings

{
  "model_mesh": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019
  }
}

Other types#

MultiImageInputModel#

image_urls list<string>* required

List of URLs of input images to convert to 3D

seed integer

Random seed for reproducibility

ss_guidance_strength float

Guidance strength for sparse structure generation Default value: 7.5

ss_sampling_steps integer

Sampling steps for sparse structure generation Default value: 12

slat_guidance_strength float

Guidance strength for structured latent generation Default value: 3

slat_sampling_steps integer

Sampling steps for structured latent generation Default value: 12

mesh_simplify float

Mesh simplification factor Default value: 0.95

texture_size TextureSizeEnum

Texture resolution Default value: "1024"

Possible enum values: 512, 1024, 2048

multiimage_algo MultiimageAlgoEnum

Algorithm for multi-image generation Default value: "stochastic"

Possible enum values: stochastic, multidiffusion

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.

Related Models