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

# Runway Aleph Python SDK for RunAPI

The Runway Aleph Python SDK is the language-specific package for Runway Aleph on
RunAPI. Use it for prompt-guided video editing when your application needs JSON
request bodies, task status lookup, and consistent RunAPI errors in Python.

For model details, use https://runapi.ai/models/runway-aleph; for API reference,
use https://runapi.ai/docs#runway-aleph; for SDK docs, use
https://runapi.ai/docs#sdk-runway-aleph.

## Install

```bash
pip install runapi-runway-aleph
```

## Quick start

```python
from runapi.runway_aleph import RunwayAlephClient

client = RunwayAlephClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."

task = client.edit_video.create(
    model="runway-aleph",
    prompt="Transform the scene into a watercolor painting style",
    source_video_url="https://cdn.runapi.ai/public/samples/video.mp4",
)
status = client.edit_video.get(task.id)
```

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.edit_video.run(
    model="runway-aleph",
    prompt="Transform the scene into a watercolor painting style",
    source_video_url="https://cdn.runapi.ai/public/samples/video.mp4",
)
print(result.videos[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 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.runway_aleph` error
classes when building video jobs, workers, or scripts. The available resource is
`edit_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/runway-aleph
- SDK docs: https://runapi.ai/docs#sdk-runway-aleph
- Product docs: https://runapi.ai/docs#runway-aleph
- Pricing and rate limits: https://runapi.ai/models/runway-aleph
- Full catalog: https://runapi.ai/models

## License

Licensed under the Apache License, Version 2.0.
