# topaz/video/upscale-generative

> Topaz Video Upscale Generative restores and upscales real and AI-generated videos with Topaz Starlight diffusion models, reconstructing detail and improving visual quality for low-resolution footage, generative video, restoration, and production workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

## Overview

- **Endpoint**: `https://api.wavespeed.ai/api/v3/topaz/video/upscale-generative`
- **Polling/result URL**: `https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result`
- **Model ID**: `topaz/video/upscale-generative`
- **Category**: upscale-video

## Pricing

Pricing is calculated upfront from the source video duration and selected resolution and processing model. The source duration is rounded up to the next whole second, capped at 300 seconds for billing. The minimum charge is **$0.10**, and the total is rounded up to the next **$0.10**.

### Example Costs

For a **10-second source video**:

| Model | 720p | 1080p | 2k | 4k |
| --- | --- | --- | --- | --- |
| Starlight Precise 2.6 / Starlight Precise 2.5 / Starlight Fast 3 / Starlight Mini | $1.20 | $1.20 | $2.60 | $2.60 |
| Starlight Fast 2 | $0.60 | $0.60 | $1.30 | $1.30 |

Examples use the selected resolution and a billing basis of 30 source frames per second. Other durations have different totals; the displayed price is calculated before submission.

---

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

- **`video`** (`string`, _required_):
  The video to process.

- **`model`** (`string`, _optional_):
  The Topaz model to use. Starlight Precise 2.6: High-quality generative upscaling and enhancement up to 4K (default). Starlight Precise 2.5: Improved realism for AI-generated video. Starlight Fast 3: The fastest Starlight model. Starlight Fast 2: Fast diffusion upscaling with higher fidelity. Starlight Mini: Diffusion restoration for archival and degraded footage.
  - Default: `"Starlight Precise 2.6"`
  - Options: "Starlight Precise 2.6", "Starlight Precise 2.5", "Starlight Fast 3", "Starlight Fast 2", "Starlight Mini"

- **`target_resolution`** (`string`, _optional_):
  Target resolution to upscale to. The source aspect ratio is preserved.
  - Default: `"1080p"`
  - Options: "720p", "1080p", "2k", "4k"



**Required Parameters Example**:

```json
{
  "video": "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4"
}
```

**Full Example**:

```json
{
  "video": "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4",
  "model": "Starlight Precise 2.6",
  "target_resolution": "1080p"
}
```

### 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'
{
  "video": "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4"
}
JSON
)

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