# heygen/video-1.0/reference-to-video

> HeyGen Video 1.0 Reference-to-Video generates high-quality AI videos guided by image, video, and optional audio references, with prompt-controlled scenes and output up to 2K for character consistency, product videos, social content, marketing creatives, and production workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/heygen/video-1.0/reference-to-video`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `heygen/video-1.0/reference-to-video`
- **Category**: reference-to-video

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

- **`prompt`** (`string`, _required_):
  Describe the scene, action, and camera movement.

- **`reference_images`** (`array of string (uri)`, _optional_):
  Optional reference image URLs (0-9). Provide images or videos. Omit this field when unused. Maximum 16 MiB per image.

- **`reference_videos`** (`array of string (uri)`, _optional_):
  Optional reference video URLs (0-3). Only the first 5 seconds of each video are used; longer clips are trimmed before generation. Retained video duration adds to the price, up to 15 seconds combined. Provide images or videos. Omit this field when unused. Maximum 32 MiB per file.

- **`reference_audios`** (`array of string (uri)`, _optional_):
  Optional reference audio URLs (0-3). Requires reference images or videos. Omit this field when unused. Maximum 32 MiB per file.

- **`duration`** (`integer`, _optional_):
  Requested video duration in seconds.
  - Default: `5`
  - Range: `5` to `15`

- **`resolution`** (`string`, _optional_):
  Output video resolution.
  - Default: `"768p"`
  - Options: "480p", "768p", "1080p", "2k"

- **`aspect_ratio`** (`string`, _optional_):
  Output framing: landscape (16:9) or portrait (9:16).
  - Default: `"16:9"`
  - Options: "16:9", "9:16"

- **`prompt_enhancement`** (`string`, _optional_):
  Optional prompt enhancement. Disabled by default.
  - Default: `"disabled"`
  - Options: "disabled", "turbo", "quality"

- **`seed`** (`integer`, _optional_):
  Random seed. Omit for a random result.
  - Range: `0` to `2.147483647e+09`



**Required Parameters Example**:

```json
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed"
}
```

**Full Example**:

```json
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed",
  "reference_images": [],
  "reference_videos": [],
  "reference_audios": [],
  "duration": 5,
  "resolution": "768p",
  "aspect_ratio": "16:9",
  "prompt_enhancement": "disabled",
  "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'
{
  "prompt": "A cinematic ocean wave at sunrise, highly detailed"
}
JSON
)

SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --request POST \
  --url https://api.wavespeed.ai/api/v3/heygen/video-1.0/reference-to-video \
  --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/heygen/video-1.0/reference-to-video)
- [API Documentation](https://wavespeed.ai/docs/docs-api/heygen/heygen-video-1.0-reference-to-video)