inpaint

Status: Available

This method inpaints (fills masked regions) of an image using ImagineoAI's backend. It supports using a mask, an original run, or a composite image, with optional prompt overrides.

Usage

const result = await client.images.inpaint({
  mask_image_url: 'https://example.com/mask.png',
  image_url: 'https://example.com/image.png',
  prompt: 'remove the watermark'
});
// result: GenerateImageOutput

Parameters

• input: InpaintImageInput
  • mask_image_url (string, required): URL of the mask image
  • original_run_id (string, optional): Run ID to base inpaint on
  • image_url (string, optional): URL of the input image
  • composite_image_url (string, optional): URL of a composite image
  • prompt (string, optional): Prompt for inpainting
  • creativity (number, optional): Creativity factor [0,1]
  • model_id (string, optional): Model to use
  • model_weight (number, optional): Model blend weight
  • webhook_url (string, optional): Webhook for status updates
  • override_original_prompt (boolean, optional): If true, overrides the original prompt
  • 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 }