Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
The image object represents generated, processed, or uploaded images in the Freddy API. This object is returned by various image-related endpoints.

Properties

url string Direct URL to the image file. These URLs expire after 1 hour for security reasons.

revised_prompt string (optional) For generated images, this field contains the AI-revised version of the original prompt.

seed integer (optional) For generated images, this field contains the random seed used for generation, allowing for reproducible results.

original_size object (optional) For upscaled images, contains the original dimensions.

  • width: number - Original width in pixels
  • height: number - Original height in pixels

upscaled_size object (optional) For upscaled images, contains the new dimensions after upscaling.

  • width: number - Upscaled width in pixels
  • height: number - Upscaled height in pixels

foreground_mask string (optional) For background removal/replacement operations, contains a URL to the foreground mask image showing which parts were identified as foreground.

background_removed boolean (optional) For background removal operations, always true when present.

background_replaced boolean (optional) For background replacement operations, always true when present.

cleanup_mask string (optional) For cleanup operations, contains a URL to the cleanup mask showing what areas were modified.

objects_removed array (optional) For cleanup operations, contains a list of objects or elements that were removed from the image.

Example Image Object

{
  "url": "https://api.freddy.aitronos.com/generated-images/img_abc123.png",
  "revised_prompt": "A serene mountain landscape at sunset with a crystal clear lake in the foreground, digital art style",
  "seed": 123456789
}

Example Upscaled Image Object

{
  "url": "https://api.freddy.aitronos.com/upscaled-images/img_def456.png",
  "original_size": {
    "width": 512,
    "height": 512
  },
  "upscaled_size": {
    "width": 1024,
    "height": 1024
  }
}

Example Background-Removed Image Object

{
  "url": "https://api.freddy.aitronos.com/processed-images/img_ghi789.png",
  "foreground_mask": "https://api.freddy.aitronos.com/masks/mask_ghi789.png",
  "background_removed": true
}

Example Cleanup Image Object

{
  "url": "https://api.freddy.aitronos.com/cleaned-images/img_jkl012.jpg",
  "cleanup_mask": "https://api.freddy.aitronos.com/masks/cleanup_jkl012.png",
  "objects_removed": ["trash can", "power lines"]
}