Class: RunApi::IdeogramV3::Client

Inherits:
Core::Client
  • Object
show all
Defined in:
lib/runapi/ideogram_v3/client.rb

Overview

Ideogram V3 image generation API client.

Supports text-to-image, inpaint editing, remix, and reframe operations. Character model variants add character consistency from reference images.

Examples:

client = RunApi::IdeogramV3::Client.new(api_key: "your-api-key")
result = client.text_to_image.run(
  model: "ideogram-v3-text-to-image",
  prompt: "A cinematic lakeside at twilight"
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key: nil, **options) ⇒ Client

Returns a new instance of Client.



26
27
28
29
30
31
32
 
# File 'lib/runapi/ideogram_v3/client.rb', line 26

def initialize(api_key: nil, **options)
  super
  @text_to_image = Resources::TextToImage.new(http)
  @edit_image = Resources::EditImage.new(http)
  @remix_image = Resources::RemixImage.new(http)
  @reframe_image = Resources::ReframeImage.new(http)
end

Instance Attribute Details

#edit_image ⇒ Resources::EditImage (readonly)

Returns Inpaint-with-mask editing operations.

Returns:



20
21
22
 
# File 'lib/runapi/ideogram_v3/client.rb', line 20

def edit_image
  @edit_image
end

#reframe_image ⇒ Resources::ReframeImage (readonly)

Returns Aspect ratio reframing operations.

Returns:



24
25
26
 
# File 'lib/runapi/ideogram_v3/client.rb', line 24

def reframe_image
  @reframe_image
end

#remix_image ⇒ Resources::RemixImage (readonly)

Returns Prompt-guided image variation operations.

Returns:



22
23
24
 
# File 'lib/runapi/ideogram_v3/client.rb', line 22

def remix_image
  @remix_image
end

#text_to_image ⇒ Resources::TextToImage (readonly)

Returns Text-to-image generation operations.

Returns:



18
19
20
 
# File 'lib/runapi/ideogram_v3/client.rb', line 18

def text_to_image
  @text_to_image
end