runapi-flux-2 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5fc862c9c9b7e20945a3e8c714a4385338ab39157df4f2bca9d9576b0e67f9c
-  data.tar.gz: 58c1c05e82241145801f4c2d78720fd487c8d5cef7ea2cb9c6abae187c7df08c
+  metadata.gz: 5c62a0872a2952d047ff3263dc0def4d5b5db1c6f0c37126fc0299147453037b
+  data.tar.gz: da871e92d952eacff9d32c85bcd506795a7678a70e5978915e8bc60e84fe6bb7
 SHA512:
-  metadata.gz: 5bc7816e95f93c880838f604b992a1cecd4fa8014fbe848e6c8181a47445055f63c43dc257cfe9caf17b90e399db5ec6fffaa0aec4f15024b6f94b2cebed45f0
-  data.tar.gz: '0856bee6cebfd10be5691713841bea72b654a5f9068adb9cea1cd51bb46b61e1983a8a3f6254708b49ff2a2eae220c3ebaacd4b0971463a4276bf1cac5d52fbf'
+  metadata.gz: 61c06e5fdc27b9707af59dd39597f2b981406552c1e4167f0e84e5fba2c527cdbc6ba5da7e764a21afcd03b23dfd3fce8226505bf4260964a06ac503ae2010d8
+  data.tar.gz: 27a3aad268c8753021c6d99d13fb7c2e2e6ffd2d629280ae094627c1ce94ad968c69ac3cfebe1f695d7d42257520ebed0dfa2b89e89306a0bf7e06ff3c8f6bc9

data/README.md

@@ -34,6 +34,8 @@ remix = client.remix_image.create(
 
 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.

data/lib/runapi/flux_2/client.rb

@@ -2,22 +2,24 @@
 
 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.
-      attr_reader :text_to_image, :remix_image
+    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

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

@@ -3,6 +3,8 @@
 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
 

data/lib/runapi/flux_2/types.rb

@@ -2,6 +2,8 @@
 
 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-remix-image
@@ -11,13 +13,16 @@ module RunApi
       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
+      # 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 }
@@ -32,9 +37,11 @@ module RunApi
         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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-flux-2
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        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