Class: RunApi::Kling::Resources::AiAvatar

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

Overview

Kling AI avatar generation resource. Generate talking avatar videos from images and audio.

Constant Summary collapse

ENDPOINT = 
"/api/v1/kling/ai_avatar"
RESPONSE_CLASS = 
Types::AiAvatarResponse
COMPLETED_RESPONSE_CLASS = 
Types::CompletedAiAvatarResponse

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ AiAvatar

Returns a new instance of AiAvatar.



16
17
18
 
# File 'lib/runapi/kling/resources/ai_avatar.rb', line 16

def initialize(http)
  @http = http
end

Instance Method Details

#create(**params) ⇒ RunApi::Kling::Types::AiAvatarResponse

Create an AI avatar generation task.

Parameters:

  • params (Hash) —

    AI avatar parameters

Returns:



33
34
35
36
37
 
# File 'lib/runapi/kling/resources/ai_avatar.rb', line 33

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

#get(id) ⇒ RunApi::Kling::Types::AiAvatarResponse

Get AI avatar task status by task ID.

Parameters:

  • id (String) —

    task ID

Returns:



43
44
45
 
# File 'lib/runapi/kling/resources/ai_avatar.rb', line 43

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

#run(**params) ⇒ RunApi::Kling::Types::CompletedAiAvatarResponse

Generate an AI avatar video and wait until complete.

Parameters:

  • params (Hash) —

    AI avatar parameters

Returns:



24
25
26
27
 
# File 'lib/runapi/kling/resources/ai_avatar.rb', line 24

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