Metadata-Version: 2.4
Name: runapi-topaz
Version: 0.1.0
Summary: Topaz image and video upscale client for RunAPI
Project-URL: Homepage, https://runapi.ai/models/topaz
Project-URL: Documentation, https://runapi.ai/docs#sdk-topaz
Author-email: RunAPI <contact@runapi.ai>
License-Expression: Apache-2.0
Keywords: ai,runapi,sdk,topaz,upscale-image,upscale-video
Requires-Python: >=3.9
Requires-Dist: runapi-core
Description-Content-Type: text/markdown

# 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

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

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

- 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
- Full catalog: https://runapi.ai/models

## License

Licensed under the Apache License, Version 2.0.
