# Hi3D Image to Relief

> Generate a 3D relief depth map with Hi3D from a single image.


## Overview

- **Endpoint**: `https://fal.run/hitem3d/hi3d/image-to-relief`
- **Model ID**: `hitem3d/hi3d/image-to-relief`
- **Category**: image-to-image
- **Kind**: inference
**Tags**: depth, hi3d, relief



## Pricing

Your request will cost **$0.2** per generation.

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:


- **`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"

- **`remove_background`** (`boolean`, _optional_):
  Whether to remove the image background before generation. Default value: `true`
  - Default: `true`

- **`output_format`** (`OutputFormatEnum`, _optional_):
  File format of the generated depth map. Default value: `"png"`
  - Default: `"png"`
  - Options: `"png"`, `"exr"`

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



**Required Parameters Example**:

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

**Full Example**:

```json
{
  "image_url": "https://storage.googleapis.com/falserverless/example_inputs/dog.png",
  "remove_background": true,
  "output_format": "png",
  "enable_safety_checker": true
}
```


### Output Schema

The API returns the following output format:

- **`depth_map`** (`File`, _required_):
  Generated depth map file (PNG or EXR).

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



**Example Response**:

```json
{
  "depth_map": {
    "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/image-to-relief \
  --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/image-to-relief",
    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/image-to-relief", {
  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/image-to-relief)
- [API Documentation](https://fal.ai/models/hitem3d/hi3d/image-to-relief/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=hitem3d/hi3d/image-to-relief)

### 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`