Flux Kontext text-to-image and image-editing client for RunAPI
Project description
Flux Kontext API Python SDK for RunAPI
The flux kontext api Python SDK is the language-specific package for Flux Kontext on RunAPI. Use this flux kontext 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 flux kontext api README is the Python package guide inside the public flux-kontext-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/flux-kontext; for API reference, use https://runapi.ai/docs#flux-kontext; for SDK docs, use https://runapi.ai/docs#sdk-flux-kontext.
Install
pip install runapi-flux-kontext
Quick start
from runapi.flux_kontext import FluxKontextClient
client = FluxKontextClient() # reads RUNAPI_API_KEY, or pass api_key="sk-..."
task = client.text_to_image.create(
model="flux-kontext-pro",
prompt="A cinematic product photo on warm paper",
aspect_ratio="1:1",
)
status = client.text_to_image.get(task.id)
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-kontext-pro",
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_kontext error classes when building image jobs or scripts. The available resource is text_to_image. 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/flux-kontext
- SDK docs: https://runapi.ai/docs#sdk-flux-kontext
- Product docs: https://runapi.ai/docs#flux-kontext
- Pricing and rate limits: https://runapi.ai/models/flux-kontext/pro
- Provider comparison: https://runapi.ai/providers/black-forest-labs
- Full catalog: https://runapi.ai/models
- Repository: https://github.com/runapi-ai/flux-kontext-sdk
License
Licensed under the Apache License, Version 2.0.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file runapi_flux_kontext-0.1.0.tar.gz.
File metadata
- Download URL: runapi_flux_kontext-0.1.0.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d5716f8bcfd8c0715b44561f6b0aeb91401c48df68b56835b2d3175e17f17d96
|
|
| MD5 |
2eab443840ffc2e5fc9a7a9e7828f761
|
|
| BLAKE2b-256 |
7010549f0d09becb4df620651ae84590980be783ec928f8e5319d386ef32a8ac
|
File details
Details for the file runapi_flux_kontext-0.1.0-py3-none-any.whl.
File metadata
- Download URL: runapi_flux_kontext-0.1.0-py3-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86ee331bba8663c8b1eb552ca9dda56928e2d1f6573fecdc98225f81fecd4174
|
|
| MD5 |
b5a6f29bfc85ad3bfab34229350f3bd9
|
|
| BLAKE2b-256 |
79a5c2b7bbe54fb40d848e27d59e3b8af11f7e96fa346d01677467665299d010
|