Metadata-Version: 2.4
Name: runapi-topaz
Version: 0.2.0
Summary: RunAPI Topaz SDK for image and video upscaling workflows in JavaScript, Python, Ruby, Go, Java, and PHP
Project-URL: Homepage, https://runapi.ai/models/topaz
Project-URL: Documentation, https://runapi.ai/docs#sdk-topaz
Project-URL: Source, https://github.com/runapi-ai/topaz-sdk
Project-URL: Issues, https://github.com/runapi-ai/topaz-sdk/issues
Project-URL: Changelog, https://github.com/runapi-ai/topaz-sdk/blob/main/CHANGELOG.md
Project-URL: Release Notes, https://github.com/runapi-ai/topaz-sdk/releases/tag/python%2Fv0.2.0
Author-email: RunAPI <contact@runapi.ai>
License-Expression: Apache-2.0
Keywords: api,golang,gradle,image-upscaling,java,maven,python,ruby,runapi,runapi-ai,sdk,topaz,topaz-api,typescript,upscaling,video-upscaling
Requires-Python: >=3.9
Requires-Dist: runapi-core>=0.3.0
Description-Content-Type: text/markdown

# 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

```bash
pip install runapi-topaz
```

## Quick start

```python
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:

```python
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

- Model page: https://runapi.ai/models/topaz
- SDK docs: https://runapi.ai/docs#sdk-topaz
- Product docs: https://runapi.ai/docs#topaz
- Pricing and rate limits: https://runapi.ai/models/topaz/upscale-image
- Provider comparison: https://runapi.ai/providers/topaz
- Full catalog: https://runapi.ai/models
- Repository: https://github.com/runapi-ai/topaz-sdk

## License

Licensed under the Apache License, Version 2.0.
