Topaz Video Upscale Creative API Documentation
Playground
Try it on WaveSpeedAI!Topaz Video Upscale Creative creatively upscales AI-generated video with Topaz Astra, inventing new detail. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
Topaz Video Upscale Creative creatively upscales AI-generated video with Topaz Astra, inventing new detail, powered by Topaz Labs models.
Why Choose This?
-
Professional Topaz quality
The same models used by photographers, filmmakers and studios. -
Choose the right model
2 Topaz models, each tuned for a different kind of video. -
Pay for what you process
Pricing follows the size of the output, matching Topaz’s own rates.
Parameters
| Parameter | Required | Description |
|---|---|---|
| video | Yes | The video to process. |
| model | No | The Topaz model to use. Default: Astra 2. |
| target_resolution | No | Target resolution to upscale to. The source aspect ratio is preserved. Options: 720p, 1080p, 2k, 4k. Default: 1080p. |
| prompt | No | Optional description of the video or the result you want (Astra 2). |
| creativity | No | How much new detail is invented: low stays faithful, high is most creative. Options: low, middle, high. Default: low. |
Models
| Model | Best for |
|---|---|
| Astra 2 | Creative upscaling for GenAI video with prompt control (default; up to 9000 frames). |
| Astra 1 | Creative upscaling for GenAI video to 4K. |
Pricing
Priced per output frame. Astra 2: $0.10 per 10 frames up to 1080p output, per 6 frames above. Astra 1: $0.10 per 7.68 frames up to 1080p, per 4.3 frames above. Minimum $0.10.
How to Use
- Upload your video — Provide a URL or upload a file.
- Pick a model — Start with the default
Astra 2and switch if your content needs it. - Choose the target resolution —
720p,1080p,2k,4k. - Submit — Download the result when it is ready.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
Submit Task & Query Result
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
REQUEST_BODY=$(cat <<'JSON'
{
"video": "https://interactive-examples.mdn.mozilla.net/media/cc0-videos/flower.mp4",
"model": "Astra 2",
"target_resolution": "1080p",
"creativity": "low"
}
JSON
)
# 1. Submit the prediction once. Never retry this request automatically:
# a retry after an unclear failure can create a second, billed task.
CHECK='The task may already exist. Check History or the predictions list before submitting again.'
if ! SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 \
-X POST "https://api.wavespeed.ai/api/v3/topaz/video/upscale-creative" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}"); then
printf 'Submit failed. %s\n' "${CHECK}" >&2
exit 1
fi
TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
printf 'Submission response did not contain a prediction id. %s\n' "${CHECK}" >&2
exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"
# 2. Poll until the prediction reaches a final status.
BODY_FILE=$(mktemp)
trap 'rm -f "${BODY_FILE}"' EXIT
while true; do
# Transient errors (429, 5xx) are retried, honoring Retry-After.
HTTP_CODE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 --retry 5 --retry-delay 2 \
--output "${BODY_FILE}" --write-out '%{http_code}' \
"${RESULT_URL}" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" || true)
case "${HTTP_CODE}" in
2??) ;;
000|429|5??) # dropped connection or temporary error: keep polling
printf 'Task %s: HTTP %s, polling again in 10s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
sleep 10; continue ;;
*) printf 'Task %s: HTTP %s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
cat "${BODY_FILE}" >&2; exit 1 ;;
esac
RESULT=$(jq 'if type == "object" and has("data") then .data else . end' "${BODY_FILE}")
STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')
case "${STATUS}" in
completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
failed|cancelled|timeout|deleted)
printf 'Task %s ended with status %s\n' "${PREDICTION_ID}" "${STATUS}" >&2
printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
*) sleep 2 ;;
esac
doneRetry temporary errors only while polling, never the submit request. Errors, retries and timeouts
Parameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| video | string | Yes | - | The video to process. | |
| model | string | No | Astra 2 | Astra 2, Astra 1 | The Topaz model to use. Astra 2: Creative upscaling for GenAI video with prompt control (default; up to 9000 frames). Astra 1: Creative upscaling for GenAI video to 4K. |
| target_resolution | string | No | 1080p | 720p, 1080p, 2k, 4k | Target resolution to upscale to. The source aspect ratio is preserved. |
| prompt | string | No | - | Optional description of the video or the result you want (Astra 2). | |
| creativity | string | No | low | low, middle, high | How much new detail is invented: low stays faithful, high is most creative. |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data.id | string | Unique identifier for the prediction, Task Id |
| data.model | string | Model ID used for the prediction |
| data.outputs | array | Output values, usually URL strings; some models return text strings or structured result objects (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Task status. completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses. |
| data.created_at | string | ISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”) |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |
Result Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | - | Task ID |
Result Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data | object | The prediction data object containing all details |
| data.id | string | Unique identifier for the prediction |
| data.model | string | Model ID used for the prediction |
| data.outputs | array<string | object> | 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. |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Status: completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses |
| data.created_at | string | ISO timestamp of when the request was created |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |