Class: RunApi::Kling::Resources::ImageToVideo

Inherits:
Object
  • Object
show all
Includes:
Core::ResourceHelpers
Defined in:
lib/runapi/kling/resources/image_to_video.rb

Overview

Kling image-to-video resource. Generate videos from an input image.

Constant Summary collapse

ENDPOINT = 
"/api/v1/kling/image_to_video"
RESPONSE_CLASS = 
Types::ImageToVideoResponse
COMPLETED_RESPONSE_CLASS = 
Types::CompletedImageToVideoResponse
V3_TURBO_MODEL = 
"kling-v3-turbo-image-to-video"
V3_TURBO_UNSUPPORTED_FIELDS = 
%i[
  aspect_ratio
  negative_prompt
  cfg_scale
  last_frame_image_url
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ ImageToVideo

Returns a new instance of ImageToVideo.



23
24
25
 
# File 'lib/runapi/kling/resources/image_to_video.rb', line 23

def initialize(http)
  @http = http
end

Instance Method Details

#create(options: nil, **params) ⇒ RunApi::Kling::Types::ImageToVideoResponse

Create an image-to-video task.

Parameters:

  • params (Hash) —

    image-to-video parameters

Returns:



40
41
42
43
44
 
# File 'lib/runapi/kling/resources/image_to_video.rb', line 40

def create(options: nil, **params)
  params = compact_params(params)
  validate_params!(params)
  request(:post, ENDPOINT, body: params, options: options)
end

#get(id, options: nil) ⇒ RunApi::Kling::Types::ImageToVideoResponse

Get image-to-video task status by task ID.

Parameters:

  • id (String) —

    task ID

Returns:



50
51
52
 
# File 'lib/runapi/kling/resources/image_to_video.rb', line 50

def get(id, options: nil)
  request(:get, "#{ENDPOINT}/#{id}", options: options)
end

#run(options: nil, **params) ⇒ RunApi::Kling::Types::CompletedImageToVideoResponse

Generate an image-to-video task and wait until complete.

Parameters:

  • params (Hash) —

    image-to-video parameters

Returns:



31
32
33
34
 
# File 'lib/runapi/kling/resources/image_to_video.rb', line 31

def run(options: nil, **params)
  task = create(options: options, **params)
  poll_until_complete { get(task.id, options: options) }
end