Skip to main content

Seedream text-to-image and edit-image client for RunAPI

Project description

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

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

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

License

Licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runapi_seedream-0.1.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runapi_seedream-0.1.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file runapi_seedream-0.1.0.tar.gz.

File metadata

  • Download URL: runapi_seedream-0.1.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_seedream-0.1.0.tar.gz
Algorithm Hash digest
SHA256 693912cf214ece6e99c576648382e5678ef7bd798c1ab6b895871e314d2a33fa
MD5 87a9b8d3b081c91f8459245946dfb7b0
BLAKE2b-256 c013e2072ac5ead428aa7909a6d378f9cf3f091de3459ca963d7a23e4ccf5609

See more details on using hashes here.

File details

Details for the file runapi_seedream-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: runapi_seedream-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_seedream-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f378eb9cbfb42b0c3b6f160cb6a14896aece10e29c51e10d91baa82897ed217a
MD5 4f6b8de7bc3fbcc376dbe0263a69e32f
BLAKE2b-256 06dfcf53e1197b5907f8b0e7c2559f262563d58aff7940cd08eba7e6770717c1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page