ideogram

Documentation

Overview

Package ideogram implements engine.Engine for the Ideogram API.

Image generation uses POST /generate with JSON body. Auth: Api-Key: {key}, env IDEOGRAM_API_KEY. Synchronous — returns image URL directly.

Index

• Constants
• Variables
• func ConfigSchema() []engine.ConfigField
• func ModelsByCapability() map[string][]string
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) Capabilities() engine.Capability
  • func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)

Constants

const (
	ModelV2A      = "V_2A"
	ModelV2ATurbo = "V_2A_TURBO"
	ModelV2       = "V_2"
	ModelV2Turbo  = "V_2_TURBO"
)

Model constants.

Variables

var (
	ErrMissingAPIKey = errors.New("ideogram: missing API key (set Config.APIKey or IDEOGRAM_API_KEY)")
	ErrMissingPrompt = errors.New("ideogram: missing prompt in workflow graph")
)

Functions

func ConfigSchema

func ConfigSchema() []engine.ConfigField

ConfigSchema returns the configuration fields required by the Ideogram engine.

func ModelsByCapability

func ModelsByCapability() map[string][]string

ModelsByCapability returns all known Ideogram models grouped by capability.

Types

type Config

type Config struct {
	APIKey     string
	BaseURL    string
	Model      string
	HTTPClient *http.Client
}

Config configures the Ideogram engine.

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine implements engine.Engine for Ideogram.

func New

func New(cfg Config) *Engine

New creates an Ideogram engine instance.

func (*Engine) Capabilities

func (e *Engine) Capabilities() engine.Capability

Capabilities implements engine.Describer.

func (*Engine) Execute

func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)

Execute generates an image via the Ideogram API.