OmniHuman Ruby SDK for RunAPI

The OmniHuman Ruby SDK is the language-specific package for OmniHuman on RunAPI. Use this package for audio-driven talking-head video generation, human identification, and subject-mask detection 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 omnihuman-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/omnihuman; for API reference, use https://runapi.ai/docs#omnihuman; for SDK docs, use https://runapi.ai/docs#sdk-omnihuman.

Install

gem install runapi-omnihuman

Quick start

require "runapi/omnihuman"

client = RunApi::Omnihuman::Client.new
task = client.audio_to_video.create(
  model: "omnihuman-1.5",
  source_image_url: "https://cdn.runapi.ai/public/samples/portrait.jpg",
  source_audio_url: "https://cdn.runapi.ai/public/samples/voice.mp3",
  output_resolution: "720p"
)
status = client.audio_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 videos, masks, 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::Omnihuman error classes when building video jobs, Rails workers, or scripts. The available resources are audio_to_video, human_identification, and subject_detection. 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.