runapi-grok-imagine 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58e4ae262b66e7ef4d87ebb55d1b2f06538bd98c995d69479020b4c57ee078e5
-  data.tar.gz: bfb6de17046de4da1688e55726992de2843d8b4d163043f077caf2c6ad5d4d73
+  metadata.gz: f1e3242748745f800a98bf97daa49bf3a9257e8cd789fd7ad641bc43bd56e864
+  data.tar.gz: 639d984e396f8ca06f774e7e52750b0ec7d23db588ec7670495673ffce3adb14
 SHA512:
-  metadata.gz: c40cd80ce506d1031d3c33d0e9c0d0d9bb87cf503f40fb2d58c0a108acc37dda04b442c51dcf75157e9f4dc2baabb43e74812bdfedc561554c63c92e75bfe81a
-  data.tar.gz: 0ce317911aee0cf7d13911413d8c0b9a03edf61f97bedaa01e7dcfc7ac7a7ffda9f049d636a823259b706d6dd03b5aba2c64ab7d4e5d852af5f611d81b2b0b77
+  metadata.gz: cc1472f349ac8211430c488460c74d5b1254069e39006247cdedc94975d86cd48d4fa6098883f876d5b9593b75c1dfbd665fd02bd2e2a237b5bd06722cc032e3
+  data.tar.gz: 0dc17d476484b3957c40ec0be32f9ad4c667ee07dd7103630bea6bb5ab8aa592624addf3ba7fbc27ff77834f1dafafd0f526d5fefe53b7786892a7d07b586564

data/README.md

@@ -1,8 +1,8 @@
-# Grok Imagine API Ruby SDK for RunAPI
+# Grok Imagine Ruby SDK for RunAPI
 
-The grok imagine api Ruby SDK is the language-specific package for Grok Imagine on RunAPI. Use this grok imagine 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.
+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, and consistent RunAPI errors in Ruby.
 
-This grok imagine api README is the Ruby package guide inside the public `grok-imagine-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/grok-imagine; for API reference, use https://runapi.ai/docs#grok-imagine; for SDK docs, use https://runapi.ai/docs#sdk-grok-imagine.
+This README is the Ruby package guide inside the public `grok-imagine-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/grok-imagine; for API reference, use https://runapi.ai/docs#grok-imagine; for SDK docs, use https://runapi.ai/docs#sdk-grok-imagine.
 
 ## Install
 
@@ -13,7 +13,7 @@ gem install runapi-grok-imagine
 ## Quick start
 
 ```ruby
-require "runapi-grok-imagine"
+require "runapi/grok_imagine"
 
 client = RunApi::GrokImagine::Client.new
 task = client.text_to_video.create(
@@ -28,14 +28,16 @@ RunAPI-generated file URLs are temporary. Download and store generated images, v
 
 ## Language notes
 
-Use Ruby keyword arguments and the `RunApi::GrokImagine` error classes when building image jobs, Rails workers, or scripts. The available resources include text to videos, image to videos, text to images, image to images, extensions, and upscales. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use Ruby keyword arguments and the `RunApi::GrokImagine` error classes when building media jobs, Rails workers, or scripts. The available resources are `text_to_video`, `image_to_video`, `text_to_image`, `edit_image`, `extensions`, and `upscales`; use `grok-imagine-video-1.5-preview` with either video resource for the preview model. 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/grok-imagine
 - SDK docs: https://runapi.ai/docs#sdk-grok-imagine
 - Product docs: https://runapi.ai/docs#grok-imagine
-- Pricing and rate limits: https://runapi.ai/models/grok-imagine/text-to-video
+- Video 1.5 Preview pricing and rate limits: https://runapi.ai/models/grok-imagine/video-1.5-preview
+- 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/contract_gen.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module RunApi
+  module GrokImagine
+    CONTRACT = {
+      "edit-image" => {
+        "models" => ["grok-imagine-edit-image"],
+        "fields_by_model" => {
+          "grok-imagine-edit-image" => {
+            "source_image_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "extend" => {
+        "models" => [],
+        "fields_by_model" => {
+          "_" => {
+            "extension_duration_seconds" => {
+              "enum" => [6, 10],
+              "type" => "integer"
+            },
+            "start_seconds" => {
+              "type" => "integer"
+            }
+          }
+        }
+      },
+      "image-to-video" => {
+        "models" => ["grok-imagine-image-to-video", "grok-imagine-video-1.5-preview"],
+        "fields_by_model" => {
+          "grok-imagine-image-to-video" => {
+            "aspect_ratio" => {
+              "enum" => ["2:3", "3:2", "1:1", "16:9", "9:16"]
+            },
+            "duration_seconds" => {
+              "type" => "integer"
+            },
+            "index" => {
+              "type" => "integer"
+            },
+            "motion_style" => {
+              "enum" => ["fun", "normal", "spicy"]
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p"]
+            }
+          },
+          "grok-imagine-video-1.5-preview" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "16:9", "9:16", "3:2", "2:3", "auto"]
+            },
+            "duration_seconds" => {
+              "min" => 1,
+              "max" => 15,
+              "type" => "integer"
+            },
+            "index" => {
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p"]
+            },
+            "prompt" => {
+              "min" => 1,
+              "max" => 4096,
+              "length" => true
+            },
+            "source_image_urls" => {
+              "required" => true
+            }
+          }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "grok-imagine-video-1.5-preview"
+          },
+          "forbidden" => ["source_task_id", "index", "motion_style", "enable_safety_checker"]
+        }]
+      },
+      "text-to-image" => {
+        "models" => ["grok-imagine-text-to-image"],
+        "fields_by_model" => {
+          "grok-imagine-text-to-image" => {
+            "aspect_ratio" => {
+              "enum" => ["2:3", "3:2", "1:1", "16:9", "9:16"]
+            }
+          }
+        }
+      },
+      "text-to-video" => {
+        "models" => ["grok-imagine-text-to-video", "grok-imagine-video-1.5-preview"],
+        "fields_by_model" => {
+          "grok-imagine-text-to-video" => {
+            "aspect_ratio" => {
+              "enum" => ["2:3", "3:2", "1:1", "16:9", "9:16"]
+            },
+            "duration_seconds" => {
+              "type" => "integer"
+            },
+            "motion_style" => {
+              "enum" => ["fun", "normal", "spicy"]
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p"]
+            }
+          },
+          "grok-imagine-video-1.5-preview" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "16:9", "9:16", "3:2", "2:3", "auto"]
+            },
+            "duration_seconds" => {
+              "min" => 1,
+              "max" => 15,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["480p", "720p"]
+            },
+            "prompt" => {
+              "required" => true,
+              "min" => 1,
+              "max" => 4096,
+              "length" => true
+            }
+          }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "grok-imagine-video-1.5-preview"
+          },
+          "forbidden" => ["motion_style", "enable_safety_checker"]
+        }]
+      },
+      "upscale-image" => {
+        "models" => [],
+        "fields_by_model" => {
+          "_" => {}
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -16,25 +16,25 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::EDIT_IMAGE_MODEL
+          validate_contract!(CONTRACT["edit-image"], params)
           raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
         end
       end

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

@@ -17,19 +17,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

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

@@ -17,25 +17,25 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::IMAGE_TO_VIDEO_MODEL
+          validate_contract!(CONTRACT["image-to-video"], params)
 
           source_image_urls = param(params, :source_image_urls)
           source_task_id = param(params, :source_task_id)
@@ -57,10 +57,6 @@ module RunApi
             end
           end
 
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :motion_style, Types::MOTION_STYLES)
-          validate_optional!(params, :output_resolution, Types::RESOLUTIONS)
-
           if param(params, :motion_style).to_s == "spicy" && source_image_urls && !source_image_urls.empty?
             raise Core::ValidationError, "spicy motion_style requires a source_task_id source image."
           end

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

@@ -16,27 +16,26 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::TEXT_TO_IMAGE_MODEL
+          validate_contract!(CONTRACT["text-to-image"], params)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
         end
       end
     end

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

@@ -16,35 +16,33 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::TEXT_TO_VIDEO_MODEL
+          validate_contract!(CONTRACT["text-to-video"], params)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :motion_style, Types::MOTION_STYLES)
-          validate_optional!(params, :output_resolution, Types::RESOLUTIONS)
 
           duration_seconds = param(params, :duration_seconds)
           if duration_seconds
             int = duration_seconds.to_i
-            unless Types::DURATION_RANGE.cover?(int)
-              raise Core::ValidationError, "duration_seconds must be an integer between 6 and 30"
+            range = (param(params, :model) == Types::PREVIEW_MODEL) ? Types::PREVIEW_DURATION_RANGE : Types::DURATION_RANGE
+            unless range.cover?(int)
+              raise Core::ValidationError, "duration_seconds must be an integer between #{range.min} and #{range.max}"
             end
           end
         end

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

@@ -17,19 +17,19 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private

data/lib/runapi/grok_imagine/types.rb

@@ -3,15 +3,9 @@
 module RunApi
   module GrokImagine
     module Types
-      TEXT_TO_VIDEO_MODEL = "grok-imagine-text-to-video"
-      IMAGE_TO_VIDEO_MODEL = "grok-imagine-image-to-video"
-      TEXT_TO_IMAGE_MODEL = "grok-imagine-text-to-image"
-      EDIT_IMAGE_MODEL = "grok-imagine-edit-image"
-
-      ASPECT_RATIOS = %w[2:3 3:2 1:1 16:9 9:16].freeze
-      MOTION_STYLES = %w[fun normal spicy].freeze
-      RESOLUTIONS = %w[480p 720p].freeze
       DURATION_RANGE = (6..30)
+      PREVIEW_MODEL = "grok-imagine-video-1.5-preview"
+      PREVIEW_DURATION_RANGE = (1..15)
       EXTENSION_DURATION_SECONDS = [6, 10].freeze
       INDEX_RANGE = (0..5)
 

data/lib/runapi/grok_imagine.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "grok_imagine/types"
+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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-grok-imagine
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
-description: The grok imagine api Ruby SDK is the language-specific package for Grok
-  Imagine on RunAPI. Use this grok imagine 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.
+        version: 0.2.11
+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,
+  and consistent RunAPI errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,6 +39,7 @@ files:
 - lib/runapi-grok_imagine.rb
 - lib/runapi/grok_imagine.rb
 - lib/runapi/grok_imagine/client.rb
+- lib/runapi/grok_imagine/contract_gen.rb
 - lib/runapi/grok_imagine/resources/edit_image.rb
 - lib/runapi/grok_imagine/resources/extensions.rb
 - lib/runapi/grok_imagine/resources/image_to_video.rb
@@ -50,9 +51,11 @@ homepage: https://runapi.ai/models/grok-imagine
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: grok-imagine
   homepage_uri: https://runapi.ai/models/grok-imagine
   documentation_uri: https://github.com/runapi-ai/grok-imagine-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/grok-imagine-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/grok-imagine-sdk/issues
   changelog_uri: https://github.com/runapi-ai/grok-imagine-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -70,5 +73,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Grok Imagine API Ruby SDK for RunAPI
+summary: Grok Imagine Ruby SDK for RunAPI
 test_files: []