Skip to main content

Seedream Python SDK for RunAPI

The Seedream Python SDK is the language-specific package for Seedream on RunAPI. Use this package for image generation, image editing, and creative production 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 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/api/seedream/text-to-image; for SDK docs, use https://runapi.ai/docs/resources/sdks.

Install

pip install runapi-seedream

Quick start

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://cdn.runapi.ai/public/samples/image.jpg"],
)

lite = client.text_to_image.create(
    model="seedream-5-lite-text-to-image",
    prompt="A bright editorial photo of a modern bookstore cafe",
    aspect_ratio="4:3",
    output_quality="basic",
    output_format="jpeg",
)

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:

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.

Seedream 5 Pro

Use seedream-5-pro-text-to-image for generation, seedream-5-pro-edit for image editing, and seedream-5-pro-layer-decomposition to separate one image into a base image and ordered transparent layers.

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, edit_image, and decompose_layers. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

License

Licensed under the Apache License, Version 2.0.

Metadata

Release files for runapi-seedream 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for runapi-seedream 0.5.0
File Size Uploaded Provenance Actions
runapi_seedream-0.5.0.tar.gz 5.6 kB Without provenance Details for runapi_seedream-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for runapi-seedream 0.5.0
File Interpreter ABI Platform Actions
runapi_seedream-0.5.0-py3-none-any.whl Python 3 none any Details for runapi_seedream-0.5.0-py3-none-any.whl

Total release size: 12.5 kB

Release files / runapi_seedream-0.5.0.tar.gz

Download URL runapi_seedream-0.5.0.tar.gz
Size 5.6 kB
Tags Source
SHA-256 checksum
How to use checksums
11a3f25c794a812cefd901345e71ce370ecde86082c5bbdfd3182a7a62eab4ac
BLAKE2b-256 checksum
How to use checksums
21e2473f9198a96a142574dcaf482eb24283517bcdf6906affa9e6d0c467e63b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / runapi_seedream-0.5.0-py3-none-any.whl

Download URL runapi_seedream-0.5.0-py3-none-any.whl
Size 6.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2ba72c7259d6cee4967090a4a842dc75e6ead01defead600ae7c2d38ce188ac0
BLAKE2b-256 checksum
How to use checksums
6b2e40ce346fe36782523b716da379b9da9dd310e1d996dfcca7bd4942b9b9d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for runapi-seedream 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page