runapi-flux-kontext 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f02b6c8d6a277adf0c9f107aba74bcd1386de50675042b279d1467355263b2ff
-  data.tar.gz: 332267483e79e90e7262bafbf7614e004d27d7562be616b20fb775285f777fa6
+  metadata.gz: 9ca7b5863c0ddfe15a6fe0f308e1098494cede66606aff70563003379d53e127
+  data.tar.gz: abc26292fc5b3debd3048e39c2a9388eeb656b9cb75f11ba61e55483494eb5dc
 SHA512:
-  metadata.gz: ebc605f974ba99711add487c2e0334a52c2a699f3d87ffb8903f6007b32bdd61294bffae2ab9eb745a35be7a3a2e078fe6f6579d5b71885d13e53f231e328e19
-  data.tar.gz: dbe3121b42f41445e749e705aa2f1472c95e0b267bd05dca64a8cfe3a786f9c2008bc818aaad435326697f2ae909a0b41e86a249948ff2bdcacdc7b4f1c4a1c7
+  metadata.gz: 839a8767907dd6ed7a1c19a87d86c0145a5d5f2e9739ff8a0ebecddf65bfb750701156522edaf7f40e373905603b00b25a2d2bdaeb5b1828922a215127d6d9bb
+  data.tar.gz: d85d4b53ee990810bd516fe8fe1bcddd4e5d0d9848c02e648642fc0a68682f2264e7874bf199c14e90e00d450210888fb56cdda5bf5172e6ef5dcdf0dc843b7a

data/README.md

@@ -0,0 +1,43 @@
+# 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.
+
+## 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/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.3
+  version: 0.2.5
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
-description: RunAPI Flux Kontext SDK for JavaScript, Ruby, and Go
+        version: 0.2.5
+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://runapi.ai/models/flux-kontext
+  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: []