Topaz Video Frame Interpolation API Documentation

Topaz Video Frame Interpolation API Documentation

Playground

Try it on WaveSpeedAI!

Topaz Video Frame Interpolation raises frame rates and creates smooth slow motion with Topaz Apollo, Chronos and Aion. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

Topaz Video Frame Interpolation raises frame rates and creates smooth slow motion with Topaz Apollo, Chronos and Aion, powered by Topaz Labs models.


Why Choose This?

  • Professional Topaz quality
    The same models used by photographers, filmmakers and studios.

  • Choose the right model
    5 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

ParameterRequiredDescription
videoYesThe video to process.
modelNoThe Topaz model to use. Default: Apollo.
fpsNoOutput frame rate. Options: 24, 25, 30, 48, 50, 60, 120. Default: 60.
slowmoNoSlow-motion factor: 2 doubles the duration, 4 quadruples it. 1 keeps the original speed. Options: 1, 2, 4, 8, 16. Default: 1.

Models

ModelBest for
ApolloPrecision slow motion and frame rate conversion (default).
Apollo FastFaster Apollo for simpler motion.
ChronosNatural slow motion for real-world motion.
Chronos FastFaster Chronos for time-sensitive work.
AionExtreme slow motion for complex, high-resolution motion.

Pricing

Chronos and Chronos Fast: $0.20 / $0.10 per gigapixel of newly generated frames. Apollo, Apollo Fast and Aion: without slow motion and up to 2x the frame rate, $0.20 / $0.10 / $0.60 per gigapixel of generated frames; otherwise $0.80 / $0.20 / $4.80 per gigapixel of the source (width × height × frames ÷ 1024³). Minimum $0.10.


How to Use

  1. Upload your video — Provide a URL or upload a file.
  2. Pick a model — Start with the default Apollo and switch if your content needs it.
  3. 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": "Apollo",
  "fps": 60,
  "slowmo": 1
}
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/frame-interpolation" \
  -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
done

Retry temporary errors only while polling, never the submit request. Errors, retries and timeouts

Parameters

Task Submission Parameters

Request Parameters

ParameterTypeRequiredDefaultRangeDescription
videostringYes-The video to process.
modelstringNoApolloApollo, Apollo Fast, Chronos, Chronos Fast, AionThe Topaz model to use. Apollo: Precision slow motion and frame rate conversion (default). Apollo Fast: Faster Apollo for simpler motion. Chronos: Natural slow motion for real-world motion. Chronos Fast: Faster Chronos for time-sensitive work. Aion: Extreme slow motion for complex, high-resolution motion.
fpsintegerNo6024, 25, 30, 48, 50, 60, 120Output frame rate.
slowmointegerNo11, 2, 4, 8, 16Slow-motion factor: 2 doubles the duration, 4 quadruples it. 1 keeps the original speed.

Response Parameters

ParameterTypeDescription
codeintegerHTTP status code (e.g., 200 for success)
messagestringStatus message (e.g., “success”)
data.idstringUnique identifier for the prediction, Task Id
data.modelstringModel ID used for the prediction
data.outputsarrayOutput values, usually URL strings; some models return text strings or structured result objects (empty when status is not completed)
data.urlsobjectObject containing related API endpoints
data.statusstringTask status. completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses.
data.created_atstringISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”)
data.errorstringError message (empty if no error occurred)
data.timingsobjectObject containing timing details
data.timings.inferenceintegerInference time in milliseconds

Result Request Parameters

ParameterTypeRequiredDefaultDescription
idstringYes-Task ID

Result Response Parameters

ParameterTypeDescription
codeintegerHTTP status code (e.g., 200 for success)
messagestringStatus message (e.g., “success”)
dataobjectThe prediction data object containing all details
data.idstringUnique identifier for the prediction
data.modelstringModel ID used for the prediction
data.outputsarray<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.urlsobjectObject containing related API endpoints
data.statusstringStatus: completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses
data.created_atstringISO timestamp of when the request was created
data.errorstringError message (empty if no error occurred)
data.timingsobjectObject containing timing details
data.timings.inferenceintegerInference time in milliseconds
© 2026 WaveSpeedAI. All rights reserved.