Flux API Ruby SDK for RunAPI

The flux api Ruby SDK is the language-specific package for Flux 2 on RunAPI. Use this flux api package for text-to-image, remix-image, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.

This flux api README is the Ruby 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

gem install runapi-flux_2

Quick start

require "runapi/flux_2"

client = RunApi::Flux2::Client.new

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://example.com/source.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. In web request handlers, prefer create plus webhook or later get polling so a worker is not held open.

Language notes

Use Ruby keyword arguments and the RunApi::Flux2 error classes when building image jobs, Rails workers, or scripts. The available resources include text_to_image and remix_image. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

License

Licensed under the Apache License, Version 2.0.