upscale

Status: Available

This method upscales an image using ImagineoAI's backend. It requires an existing run or image and supports prompt-based or original-prompt upscaling.

Usage

const result = await client.images.upscale({
  original_run_id: 'uuid-of-run',
  upscale_factor: 2,
  use_original_prompt: true
});
// result: GenerateImageOutput

Parameters

• input: UpscaleImageInput
  • original_run_id (string, required): The run ID of the image to upscale
  • upscale_factor (number, required): The factor to upscale by (e.g., 2)
  • use_original_prompt (boolean, required): If true, use the prompt from the original run
  • prompt (string, optional): Override prompt
  • model_id (string, optional): Model to use
  • model_weight (number, optional): Model blend weight
  • webhook_url (string, optional): Webhook for status updates
  • webhook_events (array, optional): Events to send to webhook

Returns

• Promise<GenerateImageOutput>

Errors

• Throws if input is invalid or API returns an error.
  • Error shape: { message: string; code?: string; details?: any }