Skip to main content

Topaz Python SDK for RunAPI

The Topaz Python SDK is the language-specific package for Topaz on RunAPI. Use this package for image upscale, video upscale, restoration, and production cleanup workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Python.

This README is the Python package guide inside the public topaz-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/topaz; for API reference, use https://runapi.ai/docs#topaz; for SDK docs, use https://runapi.ai/docs#sdk-topaz.

Install

pip install runapi-topaz

Quick start

from runapi.topaz import TopazClient

client = TopazClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."

task = client.upscale_image.create(
    model="topaz-upscale-image",
    source_image_url="https://cdn.runapi.ai/public/samples/upscale.jpg",
    upscale_factor=4,
)
status = client.upscale_image.get(task.id)

video = client.upscale_video.create(
    model="topaz-upscale-video",
    source_video_url="https://cdn.runapi.ai/public/samples/video-lowres.mp4",
    upscale_factor=2,
)

Use create to submit a task and return quickly, get to fetch the latest task state, and run when a script should create and poll until completion:

result = client.upscale_image.run(
    model="topaz-upscale-image",
    source_image_url="https://cdn.runapi.ai/public/samples/upscale.jpg",
    upscale_factor=4,
)
print(result.images[0].url)

In web request handlers, prefer create plus webhook or later get polling so a worker is not held open.

RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.

Language notes

Pass parameters as keyword arguments and catch the runapi.topaz error classes when building upscaling jobs or scripts. The available resources are upscale_image and upscale_video. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

Links

License

Licensed under the Apache License, Version 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runapi_topaz-0.2.1.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runapi_topaz-0.2.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file runapi_topaz-0.2.1.tar.gz.

File metadata

  • Download URL: runapi_topaz-0.2.1.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_topaz-0.2.1.tar.gz
Algorithm Hash digest
SHA256 51571417107a20d1202e1bca6183118245974d6f77fc4ae857acd2a760cfa82b
MD5 e393cc1759add5136abf477b0f90778c
BLAKE2b-256 e68de5c0c7b5871c2ee86fd8e2ac5f6bd11d2a66919cdb1458858d85e17b3e4f

See more details on using hashes here.

File details

Details for the file runapi_topaz-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: runapi_topaz-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_topaz-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d89e1a9992d9d5066502566d4b94066aaff939dda02cfd95f5ccd1522d275d6b
MD5 b43fcce611cd9eec24bf52f80a8f453f
BLAKE2b-256 79d074583cca610d182b71d63dc27cc2408d6804b212f9987b66c575afd8e3f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page