# hitem3d/hi3d-v3.0/image-to-3d

> Hi3D V3.0 Image-to-3D converts a single reference image into a detailed 3D mesh with optional textures, PBR materials, and multiple export formats for game assets, product visualization, 3D design, and production workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/hitem3d/hi3d-v3.0/image-to-3d`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `hitem3d/hi3d-v3.0/image-to-3d`
- **Category**: image-to-3d

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
The API is asynchronous: submit a prediction, then poll its result URL until it completes.

### Input Schema

The API accepts the following input parameters:

- **`image`** (`string`, _required_):
  Reference image for 3D model creation. PNG, JPEG, and WebP are supported, up to 20 MB.

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

- **`enable_texture`** (`boolean`, _optional_):
  Generate textures in addition to the geometry mesh.
  - Default: `true`

- **`enable_pbr`** (`boolean`, _optional_):
  Generate PBR material maps with the texture. Ignored when enable_texture is false.
  - Default: `true`

- **`face_count`** (`integer`, _optional_):
  Optional target face count. Hi3D recommends 2,000,000 for 2048quality and 5,000,000 for 2048master.
  - Default: `2e+06`
  - Range: `100000` to `5e+06`

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

- **`shading`** (`number`, _optional_):
  De-shading strength applied to the input image.
  - Default: `0.5`
  - Range: `0` to `1`



**Required Parameters Example**:

```json
{
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
}
```

**Full Example**:

```json
{
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
  "resolution": "2048quality",
  "enable_texture": true,
  "enable_pbr": true,
  "face_count": 2000000,
  "export_format": "glb",
  "shading": 0.5
}
```

### Result Data Schema

The `data` object returned by the API has the following fields:

- **`created_at`** (`string (date-time)`, _optional_):
  ISO timestamp of when the request was created (e.g., "2023-04-01T12:34:56.789Z").

- **`id`** (`string`, _optional_):
  Unique identifier for the prediction, the ID of the prediction to get.

- **`model`** (`string`, _optional_):
  Model ID used for the prediction.

- **`outputs`** (`array of string | object`, _optional_):
  Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model.

- **`status`** (`string`, _optional_):
  Status of the task: created, processing, completed, or failed.

- **`urls`** (`object`, _optional_):
  Object containing related API endpoints.



**Example `data` Object**:

```json
{
  "created_at": "example",
  "id": "example",
  "model": "example",
  "outputs": [],
  "status": "example",
  "urls": {}
}
```

## Usage Examples

The examples use `jq` to read JSON. Set your API key first:

```bash
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
```

### 1. Submit a prediction

```bash
REQUEST_BODY=$(cat <<'JSON'
{
  "image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/hitem3d/hi3d-v3.0/image-to-3d \
  --header "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  --header "Content-Type: application/json" \
  --data "${REQUEST_BODY}")

printf '%s\n' "${SUBMIT_RESPONSE}" | jq .
```

The response contains the prediction ID in `data.id`.

### 2. Poll until complete and read `outputs`

```bash
PREDICTION_ID=$(printf '%s' "${SUBMIT_RESPONSE}" | jq -r '.data.id')
if [ -z "${PREDICTION_ID}" ] || [ "${PREDICTION_ID}" = "null" ]; then
  printf 'Submission response did not contain data.id\n' >&2
  exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"

while true; do
  RESPONSE=$(curl --silent --show-error --fail-with-body \
    --request GET \
    --url "${RESULT_URL}" \
    --header "Authorization: Bearer ${WAVESPEED_API_KEY}")

  RESULT=$(printf '%s' "${RESPONSE}" | jq -e '.data')
  STATUS=$(printf '%s' "${RESULT}" | jq -er '.status')
  case "${STATUS}" in
    completed)
      # Generated files are returned in the outputs array.
      printf '%s\n' "${RESULT}" | jq '.outputs'
      break
      ;;
    failed|cancelled|timeout|deleted)
      printf '%s\n' "${RESULT}" | jq '{status, error, code}'
      exit 1
      ;;
    *)
      sleep 2
      ;;
  esac
done
```

## Additional Resources

### Documentation

- [Model Playground](https://wavespeed.ai/models/hitem3d/hi3d-v3.0/image-to-3d)
- [API Documentation](https://wavespeed.ai/docs/docs-api/hitem3d/hitem3d-hi3d-v3.0-image-to-3d)