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/api/topaz/upscale-image; for SDK docs, use https://runapi.ai/docs/resources/sdks.

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.

License

Licensed under the Apache License, Version 2.0.

Metadata

Release files for runapi-topaz 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for runapi-topaz 0.3.0
File Size Uploaded
runapi_topaz-0.3.0.tar.gz 4.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for runapi-topaz 0.3.0
File Interpreter ABI Platform
runapi_topaz-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.0 kB

Release files / runapi_topaz-0.3.0.tar.gz

Download URL runapi_topaz-0.3.0.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
3e9f130ae51a05749362c92ea9f0e069043add009a2c36785e53c750334a8864
BLAKE2b-256 checksum
How to use checksums
5de078eff7cb8cb6d0b04bbdcc6b5c0721fef465c29fe6ff02a1d1bb6932e22d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Omarchy","version":"4.0.1","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / runapi_topaz-0.3.0-py3-none-any.whl

Download URL runapi_topaz-0.3.0-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1970eb3c0a292599fdd22ead8989c6a66259ee137e69a4504af069a8f4248710
BLAKE2b-256 checksum
How to use checksums
2e91f4a4c3181ac5b03f6c492fd77e6c80b25f29609bcdef08978b4bbeb8bb92
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Omarchy","version":"4.0.1","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page