Hyper3D Rodin | Image to 3D

fal-ai/hyper3d/rodin

Rodin by Hyper3D generates realistic and production ready 3D models from text or images.

Inference

Commercial use

Partner

Schema

Playground API Examples

About

Process 3D Model

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/hyper3d/rodin", {
  input: {},
  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/hyper3d/rodin", {
  input: {},
  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/hyper3d/rodin", {
  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/hyper3d/rodin", {
  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#

prompt string

A textual prompt to guide model generation. Required for Text-to-3D mode. Optional for Image-to-3D mode. Default value: ""

input_image_urls list<string>

URL of images to use while generating the 3D model. Required for Image-to-3D mode. Optional for Text-to-3D mode.

condition_mode ConditionModeEnum

For fuse mode, One or more images are required.It will generate a model by extracting and fusing features of objects from multiple images.For concat mode, need to upload multiple multi-view images of the same object and generate the model.(You can upload multi-view images in any order, regardless of the order of view.) Default value: "concat"

Possible enum values: fuse, concat

seed integer

Seed value for randomization, ranging from 0 to 65535. Optional.

geometry_file_format GeometryFileFormatEnum

Format of the geometry file. Possible values: glb, usdz, fbx, obj, stl. Default is glb. Default value: "glb"

Possible enum values: glb, usdz, fbx, obj, stl

material MaterialEnum

Material type. Possible values: PBR, Shaded. Default is PBR. Default value: "PBR"

Possible enum values: PBR, Shaded

quality QualityEnum

Generation quality. Possible values: high, medium, low, extra-low. Default is medium. Default value: "medium"

Possible enum values: high, medium, low, extra-low

use_hyper boolean

Whether to export the model using hyper mode. Default is false.

tier TierEnum

Tier of generation. For Rodin Sketch, set to Sketch. For Rodin Regular, set to Regular. Default value: "Regular"

Possible enum values: Regular, Sketch

TAPose boolean

When generating the human-like model, this parameter control the generation result to T/A Pose.

bbox_condition list<integer>

An array that specifies the dimensions and scaling factor of the bounding box. Typically, this array contains 3 elements, Length(X-axis), Width(Y-axis) and Height(Z-axis).

addons string

Generation add-on features. Default is []. Possible values are HighPack. The HighPack option will provide 4K resolution textures instead of the default 1K, as well as models with high-poly. It will cost triple the billable units.

{
  "prompt": "A futuristic robot with sleek metallic design.",
  "input_image_urls": "https://storage.googleapis.com/falserverless/model_tests/video_models/robot.png",
  "condition_mode": "concat",
  "geometry_file_format": "glb",
  "material": "Shaded",
  "quality": "medium",
  "tier": "Regular"
}

Output#

model_mesh File* required

Generated 3D object file.

seed integer* required

Seed value used for generation.

textures list<Image>* required

Generated textures for the 3D object.

{
  "model_mesh": {
    "file_size": 2230472,
    "file_name": "base_basic_pbr.glb",
    "content_type": "application/octet-stream",
    "url": "https://v3.fal.media/files/koala/VlX4JqNI8F9HO2ETp_B7t_base_basic_pbr.glb"
  },
  "textures": [
    {
      "url": "",
      "content_type": "image/png",
      "file_name": "z9RV14K95DvU.png",
      "file_size": 4404019,
      "width": 1024,
      "height": 1024
    }
  ]
}

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.

Image#

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.

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

Hyper3D Rodin 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#

File#

Image#