Class: RunApi::GptImage::Client

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

Overview

GPT Image 1.5 generation and editing API client.

Both aspect_ratio and quality are required for all operations.

Examples:

client = RunApi::GptImage::Client.new(api_key: "your-api-key")

# Text-to-image
result = client.text_to_image.run(
  model: "gpt-image-1.5", prompt: "A futuristic cityscape"
)

# Edit image
edited = client.edit_image.run(
  model: "gpt-image-1.5",
  prompt: "Transform into oil painting",
  source_image_urls: ["https://cdn.runapi.ai/public/samples/photo.jpg"]
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Client.



29
30
31
32
33
 
# File 'lib/runapi/gpt_image/client.rb', line 29

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

Instance Attribute Details

#edit_image ⇒ Resources::EditImage (readonly)

Returns Image edit operations.

Returns:



27
28
29
 
# File 'lib/runapi/gpt_image/client.rb', line 27

def edit_image
  @edit_image
end

#text_to_image ⇒ Resources::TextToImage (readonly)

Returns Text-to-image generation operations.

Returns:



25
26
27
 
# File 'lib/runapi/gpt_image/client.rb', line 25

def text_to_image
  @text_to_image
end