0.0
The project is in a healthy, maintained state
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.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

~> 0.2.5
 Project Readme

RunAPI

Flux 2 API SDKs for JavaScript, Ruby, and Go on RunAPI.

npm RubyGems Go Reference License


The flux api SDK packages JavaScript, Ruby, and Go clients for Flux 2 on RunAPI. Use this flux api SDK for text-to-image, remix-image, and creative production workflows that need typed installs, JSON request bodies, task polling, and consistent RunAPI errors across services.

Flux 2 belongs to the Black Forest Labs catalog on RunAPI. The public model page is https://runapi.ai/models/flux-2; variant pages below carry pricing, rate-limit, and commercial-usage details. The public flux-2-sdk repository groups the JavaScript, Ruby, and Go packages for this model.

Install

npm install @runapi.ai/flux-2
gem install runapi-flux-2
go get github.com/runapi-ai/flux-2-sdk/go@latest

What you can build

  • Build product imagery, creative automation, design previews, and agent image workflows with the flux api SDK.
  • Keep one model-specific repository while installing only the language package your app needs.
  • Use create for submit-only jobs, get for status lookup, and run for submit-and-poll scripts.
  • Handle authentication, validation, rate limits, insufficient credits, task failures, and polling timeouts through RunAPI SDK errors.

The JavaScript client exposes textToImage and remixImage resources, and the Ruby and Go packages mirror the same RunAPI task lifecycle.

JavaScript quick start

import { Flux2Client } from '@runapi.ai/flux-2';

const client = new Flux2Client();

const task = await client.textToImage.create({
  model: 'flux-2-pro-text-to-image',
  prompt: 'A cinematic product photo on warm paper',
});

const status = await client.textToImage.get(task.id);
const remix = await client.remixImage.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',
});

For short scripts, use run with the same JSON body to create the task and wait for completion. For web request handlers, prefer create plus webhook or later get polling so the server does not hold a worker open.

Repository layout

  • js/ publishes @runapi.ai/flux-2.
  • ruby/ publishes runapi-flux-2 when RubyGems publishing resumes.
  • go/ publishes github.com/runapi-ai/flux-2-sdk/go and depends on github.com/runapi-ai/core-sdk/go.

Public links

Pricing and variants

Use the most specific flux api variant page for pricing, rate limits, and commercial usage:

Default pricing link for the flux api SDK: https://runapi.ai/models/flux-2/pro-text-to-image

FAQ

Which package should I install for flux api work?

Install the model package for your language: @runapi.ai/flux-2, runapi-flux-2, or github.com/runapi-ai/flux-2-sdk/go. Install core SDK packages only when you are building shared SDK infrastructure.

Where should public links point?

Primary flux api links point to https://runapi.ai/models/flux-2. Pricing and usage-policy links point to variant pages such as https://runapi.ai/models/flux-2/pro-text-to-image. Provider comparisons point to https://runapi.ai/providers/black-forest-labs, and broad browsing points to https://runapi.ai/models.

License

Licensed under the Apache License, Version 2.0.