The Python Runware SDK is used to run image inference with the Runware API, powered by the Runware inference platform. It can be used to generate imaged with text-to-image and image-to-image. It also allows the use of an existing gallery of models or selecting any model or LoRA from the CivitAI gallery. The API also supports upscaling, background removal, inpainting and outpainting, and a series of other ControlNet models.
Source: https://github.com/Runware/sdk-python
Before using the Python Runware SDK, make sure to set your Runware API key in the environment variable RUNWARE_API_KEY
. You can do this by creating a .env
file in your project root and adding the following line:
RUNWARE_API_KEY = "your_api_key_here"
To generate images using the Runware API, you can use the imageInference
method of the Runware
class. Here's an example:
from runware import Runware , IImageInference
async def main () -> None :
runware = Runware (api_key = RUNWARE_API_KEY)
await runware . connect ()
request_image = IImageInference (
positivePrompt = "a beautiful sunset over the mountains" ,
model = "civitai:36520@76907" ,
numberResults = 4 ,
negativePrompt = "cloudy, rainy" ,
useCache = False ,
height = 512 ,
width = 512 ,
)
images = await runware . imageInference (requestImage = request_image)
for image in images :
print ( f "Image URL: { image.imageURL } " )
To enhance prompts using the Runware API, you can use the promptEnhance
method of the Runware
class. Here's an example:
from runware import Runware , IPromptEnhance
async def main () -> None :
runware = Runware (api_key = RUNWARE_API_KEY)
await runware . connect ()
prompt = "A beautiful sunset over the mountains"
prompt_enhancer = IPromptEnhance (
prompt = prompt,
promptVersions = 3 ,
promptMaxLength = 64 ,
)
enhanced_prompts = await runware . promptEnhance (promptEnhancer = prompt_enhancer)
for enhanced_prompt in enhanced_prompts :
print (enhanced_prompt.text)
To remove the background from an image using the Runware API, you can use the imageBackgroundRemoval
method of the Runware
class. Here's an example:
from runware import Runware , IImageBackgroundRemoval
async def main () -> None :
runware = Runware (api_key = RUNWARE_API_KEY)
await runware . connect ()
image_path = "image.jpg"
remove_image_background_payload = IImageBackgroundRemoval (image_initiator = image_path)
processed_images = await runware . imageBackgroundRemoval (
removeImageBackgroundPayload = remove_image_background_payload
)
for image in processed_images :
print (image.imageURL)
To convert an image to text using the Runware API, you can use the imageCaption
method of the Runware
class. Here's an example:
from runware import Runware , IRequestImageToText
async def main () -> None :
runware = Runware (api_key = RUNWARE_API_KEY)
await runware . connect ()
image_path = "image.jpg"
request_image_to_text_payload = IImageCaption (image_initiator = image_path)
image_to_text = await runware . imageCaption (
requestImageToText = request_image_to_text_payload
)
print (image_to_text.text)
To upscale an image using the Runware API, you can use the imageUpscale
method of the Runware
class. Here's an example:
from runware import Runware , IImageUpscale
async def main () -> None :
runware = Runware (api_key = RUNWARE_API_KEY)
await runware . connect ()
image_path = "image.jpg"
upscale_factor = 4
upscale_gan_payload = IImageUpscale (
inputImage = image_path, upscaleFactor = upscale_factor
)
upscaled_images = await runware . imageUpscale (upscaleGanPayload = upscale_gan_payload)
for image in upscaled_images :
print (image.imageSrc)
For more detailed usage and additional examples, please refer to the examples directory.