# Hi3D Image to 3D

> Generate 3D models from a single image with Hi3D V3.0.


## Overview

- **Endpoint**: `https://fal.run/hitem3d/hi3d/v3.0/image-to-3d`
- **Model ID**: `hitem3d/hi3d/v3.0/image-to-3d`
- **Category**: image-to-3d
- **Kind**: inference
**Tags**: image-to-3d, 3d, mesh



## Pricing

Your request is billed at $0.02 per credit. Total cost is a sum of geometry, texture, and PBR credits, where geometry credits scale with resolution, texture is fixed at 10 credits, and PBR is fixed at 5 credits. On v3.0, your request will cost $2.10 (2048³quality) or $9.10 (2048³master).

For more details, see [fal.ai pricing](https://fal.ai/pricing).

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:


- **`model`** (`string`, _optional_):
  Hi3D v3.0 model version used by this endpoint. Default value: `"hi3dv3.0"`
  - Default: `"hi3dv3.0"`

- **`resolution`** (`ResolutionEnum`, _optional_):
  Generation resolution. 2048quality is the faster default; 2048master provides the highest quality. Default value: `"2048quality"`
  - Default: `"2048quality"`
  - Options: `"2048quality"`, `"2048master"`

- **`enable_texture`** (`boolean`, _optional_):
  Whether to generate textures in addition to geometry. When false, only the geometry mesh is generated (and billed). Default value: `true`
  - Default: `true`

- **`enable_pbr`** (`boolean`, _optional_):
  Generate PBR material maps together with the texture. Only supported (and billed) for v2.0/v2.1 and v3.0 models when enable_texture is true; ignored otherwise. Default value: `true`
  - Default: `true`

- **`face_count`** (`integer`, _optional_):
  Target face count. The partner recommends 2,000,000 for 2048quality and 5,000,000 for 2048master.
  - Range: `100000` to `5000000`

- **`export_format`** (`ExportFormatEnum`, _optional_):
  File format of the generated model. Default value: `"glb"`
  - Default: `"glb"`
  - Options: `"glb"`, `"obj"`, `"stl"`, `"fbx"`, `"usdz"`

- **`enable_safety_checker`** (`boolean`, _optional_):
  If set to true, input images are checked for safety before processing. Default value: `true`
  - Default: `true`

- **`image_url`** (`string`, _required_):
  URL of the input image. PNG, JPEG and WebP formats are supported, up to 20MB.
  - Examples: "https://storage.googleapis.com/falserverless/example_inputs/dog.png"

- **`shading`** (`float`, _optional_):
  De-shading strength. Default value: `0.5`
  - Default: `0.5`
  - Range: `0` to `1`, step: `0.1`



**Required Parameters Example**:

```json
{
  "image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png"
}
```

**Full Example**:

```json
{
  "model": "hi3dv3.0",
  "resolution": "2048quality",
  "enable_texture": true,
  "enable_pbr": true,
  "export_format": "glb",
  "enable_safety_checker": true,
  "image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png",
  "shading": 0.5
}
```


### Output Schema

The API returns the following output format:

- **`model_mesh`** (`File`, _required_):
  Generated 3D model file.

- **`thumbnail`** (`File`, _optional_):
  Preview image of the generated model, when available.



**Example Response**:

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


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/hitem3d/hi3d/v3.0/image-to-3d \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png"
   }'
```

### Python

Ensure you have the Python client installed:

```bash
pip install fal-client
```

Then use the API client to make requests:

```python
import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "hitem3d/hi3d/v3.0/image-to-3d",
    arguments={
        "image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png"
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)
```

### JavaScript

Ensure you have the JavaScript client installed:

```bash
npm install --save @fal-ai/client
```

Then use the API client to make requests:

```javascript
import { fal } from "@fal-ai/client";

const result = await fal.subscribe("hitem3d/hi3d/v3.0/image-to-3d", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/example_inputs/dog.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);
```


## Additional Resources

### Documentation

- [Model Playground](https://fal.ai/models/hitem3d/hi3d/v3.0/image-to-3d)
- [API Documentation](https://fal.ai/models/hitem3d/hi3d/v3.0/image-to-3d/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=hitem3d/hi3d/v3.0/image-to-3d)

### fal.ai Platform

- [Platform Documentation](https://fal.ai/docs/documentation)
- [Python Client](https://fal.ai/docs/api-reference/client-libraries/python)
- [JavaScript Client](https://fal.ai/docs/api-reference/client-libraries/javascript)

### Other agent-readable surfaces

This file covers one model. To find anything else:

- [Platform overview](https://fal.ai/llms.txt): Entry points and representative endpoint IDs
- [Documentation index](https://fal.ai/docs/llms.txt): Every documentation page
- [Full documentation text](https://fal.ai/docs/llms-full.txt): The whole documentation inlined
- Any other model: `https://fal.ai/models/<endpoint-id>/llms.txt`