DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Tripo3D Image to 3D

tripo3d/tripo/v2.5/image-to-3d
State of the art Image to 3D Object generation
Inference
Commercial use
Partner
PlaygroundAPI

About

Image To 3D

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("tripo3d/tripo/v2.5/image-to-3d", {
  input: {
    image_url: "https://platform.tripo3d.ai/assets/front-235queJB.jpg"
  },
  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("tripo3d/tripo/v2.5/image-to-3d", {
  input: {
    image_url: "https://platform.tripo3d.ai/assets/front-235queJB.jpg"
  },
  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("tripo3d/tripo/v2.5/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("tripo3d/tripo/v2.5/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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

seed integer

This is the random seed for model generation. The seed controls the geometry generation process, ensuring identical models when the same seed is used. This parameter is an integer and is randomly chosen if not set.

face_limit integer

Limits the number of faces on the output model. If this option is not set, the face limit will be adaptively determined.

pbr boolean

A boolean option to enable pbr. The default value is True, set False to get a model without pbr. If this option is set to True, texture will be ignored and used as True.

texture TextureEnum

An option to enable texturing. Default is 'standard', set 'no' to get a model without any textures, and set 'HD' to get a model with hd quality textures. Default value: "standard"

Possible enum values: no, standard, HD

texture_seed integer

This is the random seed for texture generation. Using the same seed will produce identical textures. This parameter is an integer and is randomly chosen if not set. If you want a model with different textures, please use same seed and different texture_seed.

auto_size boolean

Automatically scale the model to real-world dimensions, with the unit in meters. The default value is False.

style Enum

Defines the artistic style or transformation to be applied to the 3D model, altering its appearance according to preset options (extra $0.05 per generation). Omit this option to keep the original style and apperance.

Possible enum values: person:person2cartoon, object:clay, object:steampunk, animal:venom, object:barbie, object:christmas, gold, ancient_bronze

quad boolean

Set True to enable quad mesh output (extra $0.05 per generation). If quad=True and face_limit is not set, the default face_limit will be 10000. Note: Enabling this option will force the output to be an FBX model.

texture_alignment Enum

Determines the prioritization of texture alignment in the 3D model. The default value is original_image. Default value: original_image

Possible enum values: original_image, geometry

orientation Enum

Set orientation=align_image to automatically rotate the model to align the original image. The default value is default. Default value: default

Possible enum values: default, align_image

image_url string* required

URL of the image to use for model generation.

{
  "texture": "standard",
  "texture_alignment": "original_image",
  "orientation": "default",
  "image_url": "https://platform.tripo3d.ai/assets/front-235queJB.jpg"
}

Output#

task_id string* required

The task id of the 3D model generation.

model_mesh File

Model

base_model File

Base model

pbr_model File

Pbr model

rendered_image File

A preview image of the model

{
  "task_id": "",
  "model_mesh": {
    "file_size": 6744644,
    "content_type": "application/octet-stream",
    "url": "https://v3.fal.media/files/zebra/NA4WkhbpI-XdOIFc4cDIk_tripo_model_812c3a8a-6eb3-4c09-9f40-0563d27ae7ea.glb"
  },
  "rendered_image": {
    "file_size": 13718,
    "content_type": "image/webp",
    "url": "https://v3.fal.media/files/panda/zDTAHqp8ifMOT3upZ1xJv_legacy.webp"
  }
}

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.

Related Models