Skip to main content

RunAPI Flux 2 SDK for text-to-image and remix-image workflows in JavaScript, Python, Ruby, Go, Java, and PHP

Project description

Flux 2 API Python SDK for RunAPI

The Flux 2 Python SDK is the language-specific package for Flux 2 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 flux-2-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/flux-2; for API reference, use https://runapi.ai/docs#flux-2; for SDK docs, use https://runapi.ai/docs#sdk-flux-2.

Install

pip install runapi-flux-2

Quick start

from runapi.flux_2 import Flux2Client

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

task = client.text_to_image.create(
    model="flux-2-pro-text-to-image",
    prompt="A cinematic product photo on warm paper",
    aspect_ratio="1:1",
)
status = client.text_to_image.get(task.id)

remix = client.remix_image.create(
    model="flux-2-pro-remix-image",
    prompt="Turn this product shot into a warm editorial photo",
    source_image_urls=["https://cdn.runapi.ai/public/samples/image.jpg"],
    aspect_ratio="auto",
)

Use create when you want to submit a task and return quickly, get when you need the latest task state, and run when a script should create and poll until completion:

result = client.text_to_image.run(
    model="flux-2-pro-text-to-image",
    prompt="A futuristic cityscape at dusk",
)
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.flux_2 error classes when building image jobs or scripts. The available resources are text_to_image and remix_image. 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_flux_2-0.1.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

runapi_flux_2-0.1.1-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file runapi_flux_2-0.1.1.tar.gz.

File metadata

  • Download URL: runapi_flux_2-0.1.1.tar.gz
  • Upload date:
  • Size: 4.9 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_flux_2-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1098a0effc2f7f10e65d1e2910b8955e2a73ca164e30183567b031faba36477c
MD5 1efd912c17abf6dd59767a18f78329ae
BLAKE2b-256 5826956a54995d874b923cc738ed2bc20166574f00bfb3c2049c020279721eed

See more details on using hashes here.

File details

Details for the file runapi_flux_2-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: runapi_flux_2-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.4 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_flux_2-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c6f974f03e9f18b431e0d2d4ef44571a40a59cc905d0eb9591eb99f7b5694ca4
MD5 9b3c021bb3bc77da0001ed71cc4f32c9
BLAKE2b-256 8f96cdab5225ade3a769bd9ce28ed4911a29af6f9913798774e2af86bfcd9e0b

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