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.

Links

• Model page: https://runapi.ai/models/seedream
• SDK docs: https://runapi.ai/docs/resources/sdks
• Product docs: https://runapi.ai/docs/api/seedream/text-to-image
• 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.