runapi-flux-2 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56c69158fdf9a626666619b7457f16f9a562589eacec46f7358435e3a6cdbd26
-  data.tar.gz: 4c085ddbf1ccdea5bc7df3302801767049b10a62cb802e07415effd6afa9d822
+  metadata.gz: 5c62a0872a2952d047ff3263dc0def4d5b5db1c6f0c37126fc0299147453037b
+  data.tar.gz: da871e92d952eacff9d32c85bcd506795a7678a70e5978915e8bc60e84fe6bb7
 SHA512:
-  metadata.gz: a475f504bddc3d7319543bab106eb725de27c9c253b3fd435006cb377bde9c10e7fac49a077376f6e733d13b33f86123f8100acb4d66dfeff264b5746cc9f25c
-  data.tar.gz: c858a93fef4b6227e33a8b70645f7bd63d7f1ebe9b758ddb14eba5de3cdcaf7096fe1b72054c0d818e5e9f9f3d36dca7b44e70fcb4e7b35285598622b6810e00
+  metadata.gz: 61c06e5fdc27b9707af59dd39597f2b981406552c1e4167f0e84e5fba2c527cdbc6ba5da7e764a21afcd03b23dfd3fce8226505bf4260964a06ac503ae2010d8
+  data.tar.gz: 27a3aad268c8753021c6d99d13fb7c2e2e6ffd2d629280ae094627c1ce94ad968c69ac3cfebe1f695d7d42257520ebed0dfa2b89e89306a0bf7e06ff3c8f6bc9

data/README.md

@@ -0,0 +1,55 @@
+# 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
+
+```bash
+gem install runapi-flux_2
+```
+
+## Quick start
+
+```ruby
+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.
+
+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
+
+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.
+
+## Links
+
+- Model page: https://runapi.ai/models/flux-2
+- SDK docs: https://runapi.ai/docs#sdk-flux-2
+- Product docs: https://runapi.ai/docs#flux-2
+- Pricing and rate limits: https://runapi.ai/models/flux-2/pro-text-to-image
+- Provider comparison: https://runapi.ai/providers/black-forest-labs
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/flux-2-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/flux_2/client.rb

@@ -2,23 +2,26 @@
 
 module RunApi
   module Flux2
-    # Flux 2 text-to-image API client.
+    # Flux 2 text-to-image and remix API client.
+    #
+    # Pro and flex tiers for both text-to-image generation and
+    # text-guided image remixing.
     #
     # @example
     #   client = RunApi::Flux2::Client.new(api_key: "your-api-key")
     #   result = client.text_to_image.run(
     #     model: "flux-2-pro-text-to-image", prompt: "A futuristic cityscape"
     #   )
-    class Client
-      # @return [Resources::TextToImage] Text-to-image operations.
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation operations.
       attr_reader :text_to_image
+      # @return [Resources::RemixImage] Image remix operations with text-guided transformations.
+      attr_reader :remix_image
 
       def initialize(api_key: nil, **options)
-        @api_key = Core::Auth.resolve_api_key(api_key)
-
-        client_options = Core::ClientOptions.new(api_key: @api_key, **options)
-        http = client_options.http_client || Core::HttpClient.new(client_options)
+        super
         @text_to_image = Resources::TextToImage.new(http)
+        @remix_image = Resources::RemixImage.new(http)
       end
     end
   end

data/lib/runapi/flux_2/resources/remix_image.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Flux2
+    module Resources
+      # Flux 2 image remix resource.
+      # Transform source images guided by a text prompt.
+      class RemixImage
+        include RunApi::Core::ResourceHelpers
+
+        ENDPOINT = "/api/v1/flux_2/remix_image"
+
+        RESPONSE_CLASS = Types::RemixImageResponse
+        COMPLETED_RESPONSE_CLASS = Types::CompletedRemixImageResponse
+
+        def initialize(http)
+          @http = http
+        end
+
+        def run(**params)
+          task = create(**params)
+          poll_until_complete { get(task.id) }
+        end
+
+        def create(**params)
+          params = compact_params(params)
+          validate_params!(params)
+          request(:post, ENDPOINT, body: params)
+        end
+
+        def get(id)
+          request(:get, "#{ENDPOINT}/#{id}")
+        end
+
+        private
+
+        def validate_params!(params)
+          model = param(params, :model)
+          raise Core::ValidationError, "model is required" unless model
+          unless Types::REMIX_MODELS.include?(model)
+            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::REMIX_MODELS.join(", ")}"
+          end
+
+          prompt = param(params, :prompt)
+          raise Core::ValidationError, "prompt is required" unless prompt
+
+          validate_optional!(params, :aspect_ratio, Types::REMIX_ASPECT_RATIOS)
+          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
+          validate_source_image_urls!(params)
+        end
+
+        def validate_source_image_urls!(params)
+          urls = param(params, :source_image_urls)
+          raise Core::ValidationError, "source_image_urls is required" if urls.nil? || (urls.respond_to?(:empty?) && urls.empty?)
+        end
+      end
+    end
+  end
+end

data/lib/runapi/flux_2/resources/text_to_image.rb

@@ -51,30 +51,12 @@ module RunApi
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
 
           model = param(params, :model)
-          unless Types::MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::MODELS.join(", ")}"
+          unless Types::TEXT_TO_IMAGE_MODELS.include?(model)
+            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::TEXT_TO_IMAGE_MODELS.join(", ")}"
           end
 
-          validate_aspect_ratio!(params, model)
-          validate_optional!(params, :resolution, Types::RESOLUTIONS)
-          validate_input_urls!(params, model)
-        end
-
-        def validate_aspect_ratio!(params, model)
-          return unless param(params, :aspect_ratio)
-
-          allowed = Types::I2I_MODELS.include?(model) ? Types::ASPECT_RATIOS_I2I : Types::ASPECT_RATIOS
-          value = param(params, :aspect_ratio)
-          unless allowed.include?(value)
-            raise Core::ValidationError, "Invalid aspect_ratio: #{value}. Must be one of: #{allowed.join(", ")}"
-          end
-        end
-
-        def validate_input_urls!(params, model)
-          return unless Types::I2I_MODELS.include?(model)
-
-          urls = param(params, :input_urls)
-          raise Core::ValidationError, "input_urls is required for image-to-image models" if urls.nil? || (urls.respond_to?(:empty?) && urls.empty?)
+          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
+          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
         end
       end
     end

data/lib/runapi/flux_2/types.rb

@@ -2,25 +2,31 @@
 
 module RunApi
   module Flux2
+    # Type definitions and constants for Flux 2.
+    # Each operation has pro (higher fidelity) and flex (faster, lower cost) tiers.
     module Types
       MODELS = %w[
-        flux-2-pro-text-to-image flux-2-pro-image-to-image
-        flux-2-flex-text-to-image flux-2-flex-image-to-image
+        flux-2-pro-text-to-image flux-2-pro-remix-image
+        flux-2-flex-text-to-image flux-2-flex-remix-image
       ].freeze
-      I2I_MODELS = %w[flux-2-pro-image-to-image flux-2-flex-image-to-image].freeze
+      TEXT_TO_IMAGE_MODELS = %w[flux-2-pro-text-to-image flux-2-flex-text-to-image].freeze
+      REMIX_MODELS = %w[flux-2-pro-remix-image flux-2-flex-remix-image].freeze
 
       ASPECT_RATIOS = %w[1:1 4:3 3:4 16:9 9:16 3:2 2:3].freeze
-      ASPECT_RATIOS_I2I = %w[1:1 4:3 3:4 16:9 9:16 3:2 2:3 auto].freeze
-      RESOLUTIONS = %w[1K 2K].freeze
+      # Remix adds 'auto' to preserve the source image aspect ratio.
+      REMIX_ASPECT_RATIOS = %w[1:1 4:3 3:4 16:9 9:16 3:2 2:3 auto].freeze
+      OUTPUT_RESOLUTIONS = %w[1k 2k].freeze
 
+      # A single generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Generation result. +images+ is populated once +status+ is +"completed"+.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :images, [ -> { Image } ]
+        optional :images, [-> { Image }]
         optional :error, String
       end
 
@@ -28,7 +34,15 @@ module RunApi
       # `status: "completed"`. `images` is required so consumers never have to
       # null-check it on a successful task.
       class CompletedTextToImageResponse < TextToImageResponse
-        required :images, [ -> { Image } ]
+        required :images, [-> { Image }]
+      end
+
+      # Remix response -- same shape as generation.
+      class RemixImageResponse < TextToImageResponse
+      end
+
+      # Narrowed remix response from +run()+ where +images+ is guaranteed present.
+      class CompletedRemixImageResponse < CompletedTextToImageResponse
       end
     end
   end

data/lib/runapi/flux_2.rb

@@ -3,6 +3,7 @@
 require "runapi/core"
 require_relative "flux_2/types"
 require_relative "flux_2/resources/text_to_image"
+require_relative "flux_2/resources/remix_image"
 require_relative "flux_2/client"
 
 module RunApi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-flux-2
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,25 +15,31 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: RunAPI Flux 2 SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: 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.
 email:
 - contact@runapi.ai
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - LICENSE
+- README.md
 - lib/runapi-flux_2.rb
 - lib/runapi/flux_2.rb
 - lib/runapi/flux_2/client.rb
+- lib/runapi/flux_2/resources/remix_image.rb
 - lib/runapi/flux_2/resources/text_to_image.rb
 - lib/runapi/flux_2/types.rb
 homepage: https://runapi.ai/models/flux-2
@@ -41,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/flux-2
-  documentation_uri: https://github.com/runapi-ai/flux-2-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/flux-2-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/flux-2-sdk
   changelog_uri: https://github.com/runapi-ai/flux-2-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -60,5 +66,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Flux 2 API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Flux API Ruby SDK for RunAPI
 test_files: []