MiniMax H3 open weights is live
Docs
Log-inSign-up

hitem3d/hi3d/split

Split a 3D model into parts with Hi3D.
Learn more about Hi3D 3D Part Splitter
Inference
Commercial use
Partner
Schema
LLMs
PlaygroundAPI

Table of contents

About

Split a 3D model into parts.

Character split uses body-part templates with optional printable joints; general split works on any model by granularity level.

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("hitem3d/hi3d/split", {
  input: {
    mesh_url: "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/DamagedHelmet/glTF-Binary/DamagedHelmet.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"
});

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("hitem3d/hi3d/split", {
  input: {
    mesh_url: "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/DamagedHelmet/glTF-Binary/DamagedHelmet.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("hitem3d/hi3d/split", {
  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("hitem3d/hi3d/split", {
  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#

mesh_url string* required

URL of the input model to split. GLB, STL and OBJ formats are supported, up to 200MB.

model ModelEnum

Split model type: 'character' splits humanoid models using a template with optional joints; 'general' splits any model by granularity level. Default value: "character"

Possible enum values: character, general

part PartEnum

Character split template (used when model is 'character'): 'a' 6 parts, 'b' 5 parts, 'c' 4 parts excluding head, 'd' 4 parts including head, 'e' 3 parts, 'f' 2 parts. Default value: "a"

Possible enum values: a, b, c, d, e, f

joint JointEnum

Joint type added between character parts (used when model is 'character'). Default value: "ball"

Possible enum values: none, ball, dovetail

level LevelEnum

Split granularity (used when model is 'general'). Default value: "medium"

Possible enum values: low, medium, high

export_format ExportFormatEnum

File format of the generated model. Character split currently supports only 'glb'. Default value: "glb"

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

enable_safety_checker boolean

If set to true, inputs are checked for safety before processing. Default value: true

{
  "mesh_url": "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/DamagedHelmet/glTF-Binary/DamagedHelmet.glb",
  "model": "character",
  "part": "a",
  "joint": "ball",
  "level": "medium",
  "export_format": "glb",
  "enable_safety_checker": true
}

Output#

model_mesh File* required

Generated 3D model file.

thumbnail File

Preview image of the generated model, when available.

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

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