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.

Links

License

Licensed under the Apache License, Version 2.0.

Metadata

Release files for runapi-topaz 0.2.2

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.2.2
File Size Uploaded
runapi_topaz-0.2.2.tar.gz 4.7 kB Details

Built distribution (wheel)

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

Total release size: 10.8 kB

Release files / runapi_topaz-0.2.2.tar.gz

Download URL runapi_topaz-0.2.2.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
602475ba320d9217fad317970d8d3afbcdac3a92ba1d43a2f387ddf526974fb9
BLAKE2b-256 checksum
How to use checksums
da2329e0c74daedee9fbba17e437bc686ea5ca0cfc07e4bc5ab3b0071e03cbaa
Upload date
Uploaded using Trusted Publishing?
What is 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}

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

Download URL runapi_topaz-0.2.2-py3-none-any.whl
Size 6.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d5235b96087a627dcf6a7518c4dcfe71f70d6f6b79e12539c4bfeb95ebe445f
BLAKE2b-256 checksum
How to use checksums
4fe19ef628c8317b67ba16e1c0a479740aec6d23c0fbc892ef28857d3443e823
Upload date
Uploaded using Trusted Publishing?
What is 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}

Release history Release notifications | RSS feed

0.3.0

2 release files

0.2.3

2 release files

This release

0.2.2 This release

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