# Hunyuan 3d Pro Image To 3d

> Hunyuan 3d Pro Image To 3d API endpoint


## Overview

- **Endpoint**: `https://fal.run/fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d`
- **Model ID**: `fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d`
- **Category**: unknown
- **Kind**: inference


## Pricing

- **Price**: $0.015 per units

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:


- **`input_image_url`** (`string`, _required_):
  Front view image URL. Resolution: 128-5000px, max 8MB, formats: JPG/PNG/WEBP. Tips: simple background, single object, object >50% of frame.
  - Examples: "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.png"

- **`back_image_url`** (`string`, _optional_):
  Optional back/rear view image URL (JPG/PNG recommended).

- **`left_image_url`** (`string`, _optional_):
  Optional left side view image URL (JPG/PNG recommended).

- **`right_image_url`** (`string`, _optional_):
  Optional right side view image URL (JPG/PNG recommended).

- **`top_image_url`** (`string`, _optional_):
  Optional top view image URL (v3.1 exclusive, JPG/PNG recommended).

- **`bottom_image_url`** (`string`, _optional_):
  Optional bottom view image URL (v3.1 exclusive, JPG/PNG recommended).

- **`left_front_image_url`** (`string`, _optional_):
  Optional left-front 45 degree angle view image URL (v3.1 exclusive, JPG/PNG recommended).

- **`right_front_image_url`** (`string`, _optional_):
  Optional right-front 45 degree angle view image URL (v3.1 exclusive, JPG/PNG recommended).

- **`generate_type`** (`GenerateTypeEnum`, _optional_):
  Generation task type. Normal: textured model. Geometry: geometry-only white model (no textures). LowPoly/Sketch are not available in v3.1. Default value: `"Normal"`
  - Default: `"Normal"`
  - Options: `"Normal"`, `"Geometry"`

- **`enable_pbr`** (`boolean`, _optional_):
  Enable PBR material generation (metallic, roughness, normal textures). Ignored when generate_type is Geometry.
  - Default: `false`

- **`face_count`** (`integer`, _optional_):
  Target polygon face count. Range: 40,000-1,500,000. Default: 500,000. Default value: `500000`
  - Default: `500000`
  - Range: `40000` to `1500000`



**Required Parameters Example**:

```json
{
  "input_image_url": "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.png"
}
```

**Full Example**:

```json
{
  "input_image_url": "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.png",
  "generate_type": "Normal",
  "face_count": 500000
}
```


### Output Schema

The API returns the following output format:

- **`model_glb`** (`File`, _required_):
  Generated 3D object in GLB format.
  - Examples: {"url":"https://v3b.fal.media/files/b/0a8c3187/jOeZmtBuhdQMkDu65AkdT_model.glb","file_name":"model.glb","content_type":"model/gltf-binary","file_size":38554640}

- **`thumbnail`** (`File`, _optional_):
  Preview thumbnail of the generated model
  - Examples: {"url":"https://v3b.fal.media/files/b/0a8c3187/gxidaODj4OvPXruCfrZ-__preview.png","file_name":"preview.png","content_type":"image/png","file_size":194908}

- **`model_urls`** (`ModelUrls`, _required_):
  URLs for different 3D model formats
  - Examples: {"glb":{"url":"https://v3b.fal.media/files/b/0a8c3187/jOeZmtBuhdQMkDu65AkdT_model.glb","file_name":"model.glb","content_type":"model/gltf-binary","file_size":38554640},"obj":{"url":"https://v3b.fal.media/files/b/0a8c3186/no-aBFEDnOuthILfv-wzs_model.obj","file_name":"model.obj","content_type":"model/obj","file_size":31447160}}

- **`seed`** (`integer`, _optional_):
  The seed used for generation



**Example Response**:

```json
{
  "model_glb": {
    "url": "https://v3b.fal.media/files/b/0a8c3187/jOeZmtBuhdQMkDu65AkdT_model.glb",
    "file_name": "model.glb",
    "content_type": "model/gltf-binary",
    "file_size": 38554640
  },
  "thumbnail": {
    "url": "https://v3b.fal.media/files/b/0a8c3187/gxidaODj4OvPXruCfrZ-__preview.png",
    "file_name": "preview.png",
    "content_type": "image/png",
    "file_size": 194908
  },
  "model_urls": {
    "glb": {
      "url": "https://v3b.fal.media/files/b/0a8c3187/jOeZmtBuhdQMkDu65AkdT_model.glb",
      "file_name": "model.glb",
      "content_type": "model/gltf-binary",
      "file_size": 38554640
    },
    "obj": {
      "url": "https://v3b.fal.media/files/b/0a8c3186/no-aBFEDnOuthILfv-wzs_model.obj",
      "file_name": "model.obj",
      "content_type": "model/obj",
      "file_size": 31447160
    }
  }
}
```


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "input_image_url": "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.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(
    "fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d",
    arguments={
        "input_image_url": "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.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("fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d", {
  input: {
    input_image_url: "https://v3b.fal.media/files/b/0a8c3155/BTXNRrzOFsO6OvdSxdXmv_6ZcaGmrY.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/fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d)
- [API Documentation](https://fal.ai/models/fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/image-to-3d/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=fal-ai/hunyuan-3d-pro-image-to-3d/v3.1/pro/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`