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.2.0.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.2.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runapi_flux_2-0.2.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","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.2.0.tar.gz
Algorithm Hash digest
SHA256 2f50467733e6b02a8ebb64a1204ade004cecd48500d56a44dbfe50e05afa2da7
MD5 2e3fd8b8f5eaff88f605daa176c356ff
BLAKE2b-256 e4d8e12d90d5af30ebac301e8d5cf940152ec8047e8180e33691a3206e2e4bc5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runapi_flux_2-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05e9754813ab5922c7a103a7b3777079da0a8cf609bee9fc0b86b2c6e7ff4373
MD5 3124604ffac52e78e7d4468d20c63bea
BLAKE2b-256 eea0d4833bce9534e7f3f7276ec25cce980d30bef5e286dbaf39b0af2d255832

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