Resize Image

Resize an image to specific dimensions with control over aspect ratio and resizing method.

Request Parameters

Response

Returns the resized image in the specified or original format.

Example Request

    // example.sh
curl -X POST "https://oyyi.xyz/api/image/resize"   -H "accept: application/json" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@image.jpg" \
  -F "width=800" \
  -F "height=600" \
  -F "keep_aspect_ratio=true" \
  --output resized.jpg
  

Example with Python

    // resize.py
import requests

url = "https://oyyi.xyz/api/image/resize"

files = {
    'file': open('image.jpg', 'rb')
}

data = {
    'width': 800,
    'height': 600,
    'keep_aspect_ratio': True
}

response = requests.post(url, files=files, data=data)

# Save the resized image
with open('resized.jpg', 'wb') as f:
    f.write(response.content)
  

Example with JavaScript

    // resize.js
// Using fetch API
const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('width', '800');
formData.append('height', '600');
formData.append('keep_aspect_ratio', 'true');

fetch('https://oyyi.xyz/api/image/resize', {
  method: 'POST',
  body: formData
})
.then(response => response.blob())
.then(blob => {
  // Create a URL for the blob
  const url = URL.createObjectURL(blob);

  // Create a link to download the image
  const a = document.createElement('a');
  a.href = url;
  a.download = 'resized.jpg';
  a.click();

  // Clean up by revoking the URL
  URL.revokeObjectURL(url);
})
.catch(error => console.error('Error:', error));
  

Resizing Methods

How It Works

The resize endpoint changes the dimensions of an image using various resampling algorithms:

1. Image Loading: The uploaded image is loaded into memory.
2. Dimension Calculation: The target dimensions are calculated based on the provided parameters:
   • If both width and height are provided and keep_aspect_ratio is true, the image is resized to fit within these dimensions while maintaining its aspect ratio.
   • If both width and height are provided and keep_aspect_ratio is false, the image is stretched to exactly match these dimensions.
   • If only width or height is provided, the other dimension is calculated to maintain the aspect ratio.
   • If scale_factor is provided, the dimensions are calculated by multiplying the original dimensions by this factor.
3. Upscale Check: If upscale is false and the target dimensions would enlarge the image, the original dimensions are preserved.
4. Resampling: The image is resized using the specified method (Lanczos, Bicubic, Bilinear, or Nearest).
5. Format Conversion: If an output_format is specified, the image is converted to that format.
6. Quality Setting: For lossy formats (JPEG, WebP), the specified quality level is applied.

The result is an image with the requested dimensions, optimized according to the specified parameters.

Aspect Ratio Behavior

Error Responses

Notes

• Either width, height, or scale_factor must be provided. If multiple are provided, they are prioritized in this order: scale_factor, then width and height together, then width or height individually.
• When only one dimension (width or height) is provided, the other dimension is calculated automatically to maintain the aspect ratio.
• The Lanczos method provides the highest quality results but is also the slowest. For batch processing or real-time applications, consider using Bilinear or Bicubic methods.
• Setting upscale to false is useful to prevent image quality degradation when resizing small images to larger dimensions.
• The maximum file size allowed is 50MB.
• For animated GIFs, only the first frame will be resized unless the output format is also GIF.
• This operation preserves the alpha channel (transparency) if present in the original image and the output format supports it (PNG, WebP, GIF).

Use Cases

• Creating thumbnails for image galleries
• Optimizing images for web display
• Preparing images for social media platforms
• Standardizing image dimensions for a consistent layout
• Reducing file size by decreasing image dimensions
• Creating responsive image sets for different device sizes
• Preparing images for print at specific dimensions