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

# Seedream API Python SDK for RunAPI

The seedream api Python SDK is the language-specific package for Seedream on RunAPI. Use this seedream api package for text-to-image, image editing, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Python.

This seedream api README is the Python package guide inside the public `seedream-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/seedream; for API reference, use https://runapi.ai/docs#seedream; for SDK docs, use https://runapi.ai/docs#sdk-seedream.

## Install

```bash
pip install runapi-seedream
```

## Quick start

```python
from runapi.seedream import SeedreamClient

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

task = client.text_to_image.create(
    model="seedream-v4-text-to-image",
    prompt="A precise product render of a glass teapot on white marble",
    aspect_ratio="16:9",
    output_resolution="2k",
    output_count=3,
)
status = client.text_to_image.get(task.id)

edit = client.edit_image.create(
    model="seedream-v4-edit",
    prompt="Make it golden hour",
    source_image_urls=["https://example.com/source.jpg"],
)
```

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.text_to_image.run(
    model="seedream-v4-text-to-image",
    prompt="A serene mountain lake at dawn",
)
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.seedream` error classes when building image jobs or scripts. The available resources are `text_to_image` for text models and `edit_image` for editing models. 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/seedream
- SDK docs: https://runapi.ai/docs#sdk-seedream
- Product docs: https://runapi.ai/docs#seedream
- Pricing and rate limits: https://runapi.ai/models/seedream/v4-text-to-image
- Full catalog: https://runapi.ai/models
- Repository: https://github.com/runapi-ai/seedream-sdk

## License

Licensed under the Apache License, Version 2.0.
