runapi-flux-kontext 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f193fb776ccc4e27f15a68ab2382ff4ed6240b15eb2fed043649ca6166ba7b9f
-  data.tar.gz: 332267483e79e90e7262bafbf7614e004d27d7562be616b20fb775285f777fa6
+  metadata.gz: a7a15941bf71d6217337b7d0dfa6b1136a57f2f9763c24b3a1d4aed5533d8278
+  data.tar.gz: 0b126bee144555fba38ffe81675fdbef5933c3eb21017e54c70e86cf75a2c96f
 SHA512:
-  metadata.gz: 30b6a4d1ce8e031ca5ed8e3efc53cac9617e250275f754cc3c5898c4e76a9b8bacb0de9dc652c8bafcb82dc4bffab4d4532d7da9742ca507538038f9966ec9e7
-  data.tar.gz: dbe3121b42f41445e749e705aa2f1472c95e0b267bd05dca64a8cfe3a786f9c2008bc818aaad435326697f2ae909a0b41e86a249948ff2bdcacdc7b4f1c4a1c7
+  metadata.gz: 43a7d9be562a0877a517d0a36fe7c485f82e6ea543443787fc158721de1e968661108d0f6875a61da7e115856987384f1c9bb254f7ee239ac10b4458d5ca515c
+  data.tar.gz: 9c441b767fb721514c06266d43a3198599c27ac597b79c7cac0c8b0e630766844221a0b9f00d99d8363c5e1e38eca88ebc3d37f8272f9a74c90453ab0fa51723

data/README.md

@@ -0,0 +1,45 @@
+# Flux Kontext API Ruby SDK for RunAPI
+
+The flux kontext api Ruby SDK is the language-specific package for Flux Kontext on RunAPI. Use this flux kontext api package for text-to-image, image editing, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+
+This flux kontext api README is the Ruby package guide inside the public `flux-kontext-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/flux-kontext; for API reference, use https://runapi.ai/docs#flux-kontext; for SDK docs, use https://runapi.ai/docs#sdk-flux-kontext.
+
+## Install
+
+```bash
+gem install runapi-flux-kontext
+```
+
+## Quick start
+
+```ruby
+require "runapi-flux-kontext"
+
+client = RunApi::FluxKontext::Client.new
+task = client.generations.create(
+  # Pass the Flux Kontext JSON request body from https://runapi.ai/docs#flux-kontext.
+)
+status = client.generations.get(task.id)
+```
+
+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::FluxKontext` error classes when building image jobs, Rails workers, or scripts. The available resources include generations. 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-kontext
+- SDK docs: https://runapi.ai/docs#sdk-flux-kontext
+- Product docs: https://runapi.ai/docs#flux-kontext
+- Pricing and rate limits: https://runapi.ai/models/flux-kontext/pro
+- Provider comparison: https://runapi.ai/providers/black-forest-labs
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/flux-kontext-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/flux_kontext/client.rb

@@ -2,22 +2,22 @@
 
 module RunApi
   module FluxKontext
-    # Flux Kontext image generation API client.
+    # Flux Kontext image generation and editing API client.
+    #
+    # Supports pure text-to-image generation and image editing via
+    # source_image_url. Pro and max quality tiers available.
     #
     # @example
     #   client = RunApi::FluxKontext::Client.new(api_key: "your-api-key")
     #   result = client.text_to_image.run(
     #     model: "flux-kontext-pro", prompt: "A futuristic cityscape"
     #   )
-    class Client
+    class Client < RunApi::Core::Client
       # @return [Resources::TextToImage] Image generation operations.
       attr_reader :text_to_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)
       end
     end

data/lib/runapi/flux_kontext/types.rb

@@ -16,7 +16,7 @@ module RunApi
       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
 
@@ -24,7 +24,7 @@ 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
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-flux-kontext
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ 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 Kontext SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The flux kontext api Ruby SDK is the language-specific package for Flux
+  Kontext on RunAPI. Use this flux kontext api package for text-to-image, image editing,
+  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_kontext.rb
 - lib/runapi/flux_kontext.rb
 - lib/runapi/flux_kontext/client.rb
@@ -41,7 +46,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/flux-kontext
-  documentation_uri: https://github.com/runapi-ai/flux-kontext-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/flux-kontext-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/flux-kontext-sdk
   changelog_uri: https://github.com/runapi-ai/flux-kontext-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -60,5 +65,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Flux Kontext API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Flux Kontext API Ruby SDK for RunAPI
 test_files: []