Z-Image API Ruby SDK for RunAPI

The z-image api Ruby SDK is the language-specific package for Z-Image on RunAPI. Use this z-image 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 z-image api README is the Ruby package guide inside the public z-image-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/z-image; for API reference, use https://runapi.ai/docs#z-image; for SDK docs, use https://runapi.ai/docs#sdk-z-image.

Install

gem install runapi-z-image

Quick start

require "runapi-z-image"

client = RunApi::ZImage::Client.new
task = client.generations.create(
  # Pass the Z-Image JSON request body from https://runapi.ai/docs#z-image.
)
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::ZImage 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.

License

Licensed under the Apache License, Version 2.0.