Grok Imagine API 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.

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.

Install

gem install runapi-grok-imagine

Quick start

require "runapi-grok-imagine"

client = RunApi::GrokImagine::Client.new
task = client.text_to_video.create(
  # Pass the Grok Imagine JSON request body from https://runapi.ai/docs#grok-imagine.
)
status = client.text_to_video.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::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.

License

Licensed under the Apache License, Version 2.0.