Class: RunApi::Kling::Resources::TextToVideo

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

Overview

Kling text-to-video resource. Generate videos from text prompts.

Constant Summary collapse

ENDPOINT = 
"/api/v1/kling/text_to_video"
RESPONSE_CLASS = 
Types::TextToVideoResponse
COMPLETED_RESPONSE_CLASS = 
Types::CompletedTextToVideoResponse
V26_MODEL = 
"kling-v2.6"
V3_TURBO_MODEL = 
"kling-v3-turbo-text-to-video"
V3_TURBO_UNSUPPORTED_FIELDS = 
%i[
  enable_sound
  negative_prompt
  cfg_scale
  multi_shots
  multi_prompt
  first_frame_image_url
  last_frame_image_url
  kling_elements
].freeze

Constants included from O1ReferenceValidation

O1ReferenceValidation::O1_BLOCKED_IP_RANGES, O1ReferenceValidation::O1_IMAGE_EXTENSIONS, O1ReferenceValidation::O1_MODEL, O1ReferenceValidation::O1_NONCANONICAL_IPV4_LITERAL, O1ReferenceValidation::O1_VIDEO_EXTENSIONS

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ TextToVideo

Returns a new instance of TextToVideo.



29
30
31
 
# File 'lib/runapi/kling/resources/text_to_video.rb', line 29

def initialize(http)
  @http = http
end

Instance Method Details

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

Create a text-to-video task.

Parameters:

  • params (Hash) —

    text-to-video parameters

Returns:



46
47
48
49
50
 
# File 'lib/runapi/kling/resources/text_to_video.rb', line 46

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::TextToVideoResponse

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

Parameters:

  • id (String) —

    task ID

Returns:



56
57
58
 
# File 'lib/runapi/kling/resources/text_to_video.rb', line 56

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

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

Generate a text-to-video task and wait until complete.

Parameters:

  • params (Hash) —

    text-to-video parameters

Returns:



37
38
39
40
 
# File 'lib/runapi/kling/resources/text_to_video.rb', line 37

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