runapi-grok-imagine 0.2.14 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab7cfd304ca617d40eba1ae9daf821f868c5f2f4bf1dd8b7093c527353cd2f2
-  data.tar.gz: 59af0fe8b7f046d2e7d4ce05ab3ae1f169feb8ffe737775c8e63f4655db6ad38
+  metadata.gz: 2412da27da9fdbe2b64e75e625496bcfc0ca3ee20b725139e70397201b2f8b28
+  data.tar.gz: d691869681c3af4c284d4c26a16479126f518c34646d56958c853506f12e2811
 SHA512:
-  metadata.gz: 70f90be7565d27d6f9e57f560ac33e6b4f67c36f5c6e6d3ba0c03d88912018dcfe6baf1c77f1a34d284efcbdad3a5d95917273d8964b506727582675e6069216
-  data.tar.gz: c59bab1a8968d004599a6ff0d89106f74647d04c811c7e578af2ac75f61af89a0255c6c212cb80cccbfc4e92a9d41bbfa78fe39e9f5f68956cad5ab912b4e3ca
+  metadata.gz: 1ccf097c1e1b376bad6344a545b3c8280c913e65ae2eec4e5b933605105573e07edd60647c81d3655302fbdbf22b75eb69de6c71640b9fe2ffcb40d40ff47987
+  data.tar.gz: 4e8d3b221374ca657257eb396d482bc3d1c88b0fb642e671ae67f7dc05231f4f088c37ed592d78a878a2c638bc064a6fac51c7ffdce90cdd2db39d599a1784c9

data/README.md

@@ -22,6 +22,19 @@ task = client.text_to_video.create(
 status = client.text_to_video.get(task.id)
 ```
 
+## Edit with Image 2.0
+
+Image 2.0 edits one to five source images directly. Provide the source URLs and output aspect ratio; the edit prompt is optional. The task-based `source_task_id` and `mask_indices` fields are no longer accepted by this request.
+
+```ruby
+edit = client.edit_image.create(
+  model: "grok-imagine-image-2-0",
+  source_image_urls: ["https://cdn.runapi.ai/public/samples/input.png"],
+  aspect_ratio: "1:1",
+  prompt: "Change the background to a sunset beach"
+)
+```
+
 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.
@@ -39,7 +52,6 @@ Use Ruby keyword arguments and the `RunApi::GrokImagine` error classes when buil
 - Video 1.5 Fast pricing and rate limits: https://runapi.ai/models/grok-imagine/video-1.5-fast
 - Text-to-video pricing and rate limits: https://runapi.ai/models/grok-imagine/text-to-video
 - Image-to-video pricing and rate limits: https://runapi.ai/models/grok-imagine/image-to-video
-- Provider comparison: https://runapi.ai/providers/xai
 - Full catalog: https://runapi.ai/models
 - Repository: https://github.com/runapi-ai/grok-imagine-sdk
 

data/lib/runapi/grok_imagine/client.rb

@@ -18,6 +18,8 @@ module RunApi
       attr_reader :image_to_video
       # @return [Resources::TextToImage] Text-to-image generation operations.
       attr_reader :text_to_image
+      # @return [Resources::SegmentMap] Segmentation map generation operations.
+      attr_reader :segment_map
       # @return [Resources::EditImage] Prompt-guided image editing operations.
       attr_reader :edit_image
       # @return [Resources::Extensions] Extend a previously generated video.
@@ -31,6 +33,7 @@ module RunApi
         @text_to_video = Resources::TextToVideo.new(http)
         @image_to_video = Resources::ImageToVideo.new(http)
         @text_to_image = Resources::TextToImage.new(http)
+        @segment_map = Resources::SegmentMap.new(http)
         @edit_image = Resources::EditImage.new(http)
         @extensions = Resources::Extensions.new(http)
         @upscales = Resources::Upscales.new(http)

data/lib/runapi/grok_imagine/contract_gen.rb

@@ -4,7 +4,7 @@ module RunApi
   module GrokImagine
     CONTRACT = {
       "edit-image" => {
-        "models" => ["grok-imagine-edit-image"],
+        "models" => ["grok-imagine-edit-image", "grok-imagine-image-2-0"],
         "fields_by_model" => {
           "grok-imagine-edit-image" => {
             "model" => {
@@ -13,8 +13,37 @@ module RunApi
             "source_image_url" => {
               "required" => true
             }
+          },
+          "grok-imagine-image-2-0" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "2:3", "3:2", "16:9", "9:16", "auto"],
+              "required" => true
+            },
+            "model" => {
+              "required" => true
+            },
+            "prompt" => {
+              "max" => 390000,
+              "length" => true
+            },
+            "source_image_urls" => {
+              "required" => true,
+              "min_items" => 1,
+              "max_items" => 5
+            }
           }
-        }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "grok-imagine-edit-image"
+          },
+          "forbidden" => ["source_task_id", "mask_indices", "source_image_urls", "aspect_ratio"]
+        }, {
+          "when" => {
+            "model" => "grok-imagine-image-2-0"
+          },
+          "forbidden" => ["source_image_url", "source_task_id", "mask_indices", "enable_safety_checker"]
+        }]
       },
       "extend" => {
         "models" => [],
@@ -146,9 +175,48 @@ module RunApi
           "forbidden" => ["source_task_id", "index", "motion_style", "enable_safety_checker"]
         }]
       },
+      "segment-map" => {
+        "models" => ["grok-imagine-image-2-0"],
+        "fields_by_model" => {
+          "grok-imagine-image-2-0" => {
+            "model" => {
+              "required" => true
+            }
+          }
+        },
+        "rules" => [{
+          "required_any" => ["image_url", "source_task_id"]
+        }, {
+          "when" => {
+            "image_url" => {
+              "present" => true
+            }
+          },
+          "forbidden" => ["source_task_id"]
+        }, {
+          "when" => {
+            "source_task_id" => {
+              "present" => true
+            }
+          },
+          "forbidden" => ["image_url"]
+        }]
+      },
       "text-to-image" => {
-        "models" => ["grok-imagine-text-to-image"],
+        "models" => ["grok-imagine-image-2-0", "grok-imagine-text-to-image"],
         "fields_by_model" => {
+          "grok-imagine-image-2-0" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "2:3", "3:2", "16:9", "9:16"],
+              "required" => true
+            },
+            "model" => {
+              "required" => true
+            },
+            "prompt" => {
+              "required" => true
+            }
+          },
           "grok-imagine-text-to-image" => {
             "aspect_ratio" => {
               "enum" => ["2:3", "3:2", "1:1", "16:9", "9:16"]
@@ -162,7 +230,13 @@ module RunApi
               "length" => true
             }
           }
-        }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "grok-imagine-image-2-0"
+          },
+          "forbidden" => ["enable_safety_checker", "enable_pro"]
+        }]
       },
       "text-to-video" => {
         "models" => ["grok-imagine-text-to-video", "grok-imagine-video-1.5-fast", "grok-imagine-video-1.5-preview"],

data/lib/runapi/grok_imagine/resources/edit_image.rb

@@ -3,7 +3,11 @@
 module RunApi
   module GrokImagine
     module Resources
-      # Grok-Imagine prompt-guided image editing resource.
+      # Prompt-guided image editing resource.
+      #
+      # Image 2.0 accepts one to five source_image_urls, an aspect_ratio, and
+      # an optional prompt. The original model continues to accept a single
+      # source_image_url and prompt.
       class EditImage
         include RunApi::Core::ResourceHelpers
 
@@ -35,7 +39,6 @@ module RunApi
 
         def validate_params!(params)
           validate_contract!(CONTRACT["edit-image"], params)
-          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
         end
       end
     end

data/lib/runapi/grok_imagine/resources/segment_map.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RunApi
+  module GrokImagine
+    module Resources
+      # Produces an editable segmentation map from a public image URL.
+      # source_task_id remains accepted as a compatibility input; use image_url instead.
+      class SegmentMap
+        include RunApi::Core::ResourceHelpers
+
+        ENDPOINT = "/api/v1/grok_imagine/segment_map"
+
+        RESPONSE_CLASS = Types::SegmentMapTaskResponse
+        COMPLETED_RESPONSE_CLASS = Types::CompletedSegmentMapTaskResponse
+
+        def initialize(http)
+          @http = http
+        end
+
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
+        end
+
+        def create(options: nil, **params)
+          params = compact_params(params)
+          validate_params!(params)
+          request(:post, ENDPOINT, body: params, options: options)
+        end
+
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
+        end
+
+        private
+
+        def validate_params!(params)
+          validate_contract!(CONTRACT["segment-map"], params)
+        end
+      end
+    end
+  end
+end

data/lib/runapi/grok_imagine/types.rb

@@ -37,6 +37,21 @@ module RunApi
       class CompletedImageTaskResponse < ImageTaskResponse
         required :images, [-> { MediaUrl }]
       end
+
+      class Segment < RunApi::Core::BaseModel
+        required :url, String
+        optional :name, String
+        optional :index, Integer
+      end
+
+      class SegmentMapTaskResponse < AsyncTaskResponse
+        optional :segments, [-> { Segment }]
+        optional :error, String
+      end
+
+      class CompletedSegmentMapTaskResponse < SegmentMapTaskResponse
+        required :segments, [-> { Segment }]
+      end
     end
   end
 end

data/lib/runapi/grok_imagine.rb

@@ -6,6 +6,7 @@ require_relative "grok_imagine/contract_gen"
 require_relative "grok_imagine/resources/text_to_video"
 require_relative "grok_imagine/resources/image_to_video"
 require_relative "grok_imagine/resources/text_to_image"
+require_relative "grok_imagine/resources/segment_map"
 require_relative "grok_imagine/resources/edit_image"
 require_relative "grok_imagine/resources/extensions"
 require_relative "grok_imagine/resources/upscales"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-grok-imagine
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.16
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.4.1
 description: The Grok Imagine Ruby SDK is the language-specific package for Grok Imagine
   on RunAPI. Use this package for image and video generation, image editing, and creative
   production workflows when your application needs request bodies, task status lookup,
@@ -43,6 +43,7 @@ files:
 - lib/runapi/grok_imagine/resources/edit_image.rb
 - lib/runapi/grok_imagine/resources/extensions.rb
 - lib/runapi/grok_imagine/resources/image_to_video.rb
+- lib/runapi/grok_imagine/resources/segment_map.rb
 - lib/runapi/grok_imagine/resources/text_to_image.rb
 - lib/runapi/grok_imagine/resources/text_to_video.rb
 - lib/runapi/grok_imagine/resources/upscales.rb
@@ -71,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Grok Imagine Ruby SDK for RunAPI
 test_files: []