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.0.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.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runapi_topaz-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 493cf382fd9709a9765b3b66be7107b36ce88051b971ddd75a27ba5350dee676
MD5 5c571aecc139f1901d1514b098c92931
BLAKE2b-256 36116ac1899e9ff56528b5717e7e14d22a12fcbb5e741311454a6702ca6ca22d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runapi_topaz-0.2.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d272262926859dd890e0f4608921c8f5609332df461a95e702f953fd8394e1f8
MD5 813981c37ce28166614b737d040214d1
BLAKE2b-256 c0d933c6311654faf07d6a0c8b9e6aae13756df740277dc0b9a3ff276e46c6da

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