# hyper3d/rodin-v2/image-to-3d

> Hyper3D Rodin v2 turns a single image into production-ready 3D assets with clean topology, UVs and textures. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/hyper3d/rodin-v2/image-to-3d`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `hyper3d/rodin-v2/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:

- **`images`** (`array of string`, _required_):
  Images to be used in generation, up to 5 images. As the form data request will preserve the order of the images, the first image will be the image for material generation.

- **`prompt`** (`string`, _optional_):
  A textual prompt to guide the model generation.

- **`material`** (`string`, _optional_):
  The material type. 
  - Options: "PBR", "All", "Shaded"

- **`quality_and_mesh`** (`string`, _optional_):
  The generation quality and mesh mode.
  - Options: "4K Quad", "8K Quad", "18K Quad", "50K Quad", "2K Triangle", "20K Triangle", "150K Triangle", "500K Triangle"

- **`geometry_file_format`** (`string`, _optional_):
  The format of the output geometry file. 
  - Options: "glb", "fbx", "obj", "stl", "usdz"

- **`addons`** (`string`, _optional_):
  Generate 4K resolution texture instead of the default 2K.
If Quad mode, the number of faces will be ~16 times of the number of faces selected in the quality parameter.
  - Options: "HighPack"

- **`bbox_condition`** (`array of object`, _optional_):
  This is a controlnet that controls the maxmimum sized of the generated model.

- **`ta_pose`** (`boolean`, _optional_):
  Control the generation result to T/A Pose.

- **`use_original_alpha`** (`boolean`, _optional_):
  Used when processing the image.

- **`preview_render`** (`boolean`, _optional_):
  Provided in the download list.

- **`seed`** (`integer`, _optional_):
  Seed for random number generator. Set to 0 to use a random seed.
  - Range: `0` to `65535`



**Required Parameters Example**:

```json
{
  "images": []
}
```

**Full Example**:

```json
{
  "images": [],
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "material": "PBR",
  "quality_and_mesh": "4K Quad",
  "geometry_file_format": "glb",
  "addons": "HighPack",
  "bbox_condition": [],
  "ta_pose": false,
  "use_original_alpha": false,
  "preview_render": false,
  "seed": 0
}
```

### 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'
{
  "images": []
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/hyper3d/rodin-v2/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/hyper3d/rodin-v2/image-to-3d)
- [API Documentation](https://wavespeed.ai/docs/docs-api/hyper3d/hyper3d-rodin-v2-image-to-3d)