Skip to main content

Topaz Python SDK for RunAPI

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

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://example.com/in.jpg",
    upscale_factor=4,
)
status = client.upscale_image.get(task.id)

video = client.upscale_video.create(
    model="topaz-upscale-video",
    source_video_url="https://example.com/in.mp4",
    upscale_factor=2,
)

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

result = client.upscale_image.run(
    model="topaz-upscale-image",
    source_image_url="https://example.com/in.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 and videos 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.1.0.tar.gz (4.5 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.1.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runapi_topaz-0.1.0.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"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.1.0.tar.gz
Algorithm Hash digest
SHA256 2fcd4b7c03f899af88b05ad643d4846542f360ccdbedf2237fc968153dbeecf1
MD5 ecf944de94eeb25c4282ada50b52d0f6
BLAKE2b-256 58fbfba5dfa9b6cd60de6b91c3a6d1b853362be202a08257c46de5cf5a2196bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runapi_topaz-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b9ae2aa86e3e8d5ecd7060f7da52f5a1c5e05b2ede2fedefc1c905d9a2e3561
MD5 4d8c4ab8e3d4dcdedf95d94a53216d06
BLAKE2b-256 942c99bcd102c4b62817437e88dd3c109686376854557f88946e11718549480d

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