Hailuo API Ruby SDK for RunAPI

The Hailuo Ruby SDK is the language-specific package for Hailuo on RunAPI. Use this package for video generation, animation, and video editing workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.

This README is the Ruby package guide inside the public hailuo-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/hailuo; for API reference, use https://runapi.ai/docs#hailuo; for SDK docs, use https://runapi.ai/docs#sdk-hailuo.

Install

gem install runapi-hailuo

Quick start

require "runapi-hailuo"

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

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.

Language notes

Use Ruby keyword arguments and the RunApi::Hailuo error classes when building video jobs, Rails workers, or scripts. The available resources are text_to_video and image_to_video. 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.