Image Optimisation and Transformation API¶
The Image Optimisation API is a comprehensive tool for transforming, optimising and resizing images for a variety of use cases. With this API, you can perform advanced image operations including resizing, effects processing, color adjustments, geometric transformations, and content overlay to improve image quality and reduce file sizes.
Key Features¶
Size and Cropping¶
- Resizing images to specified dimensions with multiple fit modes (clip, scale, crop, fill, facearea)
- Advanced cropping with center, face detection, attention area, or entropy-based focus
- Device-pixel ratio (DPR) support for high-resolution displays
- Smart face detection and face-area cropping
Format and Quality Control¶
- Format conversion between JPEG, PNG, WebP, AVIF, JXL, GIF, and SVG
- Intelligent quality optimization with custom quality settings
- Lossless compression options
- Chroma subsampling control (4:2:0, 4:2:2, 4:4:4)
- Color space management
Visual Effects and Adjustments¶
- Blur Effects: Gaussian blur with intensity control (0.1-10.0)
- Sharpening: Unsharp mask and simple sharpening with configurable parameters
- Color Adjustments: Brightness, contrast, saturation, and gamma correction (-100 to +100 range)
- Tone Mapping: Hue shifting (0-359°), vibrance, highlights, and shadows adjustment
- Style Effects: Sepia, grayscale, monochrome, and duotone filters
Geometric Transformations¶
- Image rotation (0-360°)
- Horizontal and vertical flipping
- Padding with configurable per-side values
- Border addition with customizable width, color, and corner radius
Content Overlay¶
- Text overlay with font, size, color, alignment, and positioning control
- Watermark placement with opacity and position control
- Background color and fill options
Masking and Shapes¶
- Ellipse masking
- Corner radius masking for rounded corners
- Custom mask background colors
Automatic Optimization¶
- Auto format selection for optimal browser compatibility
- Auto optimization for file size reduction
- Client hints support for responsive delivery
Advanced Use Cases¶
- E-commerce: Product image standardization with consistent sizing, quality, and watermarking
- Content Management: Automatic format conversion and optimization for different devices
- Social Media: Image processing with effects, overlays, and branding
- Performance Optimization: Intelligent compression and format selection for faster loading
- Responsive Design: Device-aware image delivery with DPR and client hints support
- Brand Management: Consistent styling with color adjustments and watermarks
API Parameter Categories¶
Size Parameters¶
w
,h
- Width and height dimensionsfit
- Scaling behavior (clip, scale, crop, fill, facearea)crop
- Cropping focus (centre, faces, attention, entropy, etc.)dpr
- Device pixel ratio
Format Parameters¶
fm
- Output format (jpeg, png, webp, avif, jxl, gif, svg)q
- Quality setting (1-100 or quality preset)lossless
- Enable lossless compressionchromasub
- Chroma subsampling modecs
- Color space
Effect Parameters¶
blur
- Gaussian blur intensity (0.1-10.0)usm
- Unsharp mask intensity (0.5-5.0)usmrad
- Unsharp mask radius (1.0-10.0)sharp
- Simple sharpening (1.0-100.0)
Color Parameters¶
brightness
- Brightness adjustment (-100 to +100)contrast
- Contrast adjustment (-100 to +100)saturation
- Saturation adjustment (-100 to +100)gamma
- Gamma correction (0.1-5.0)
Tone Parameters¶
hue
- Hue shift in degrees (0-359)vib
- Vibrance adjustment (-100 to +100)high
- Highlights adjustment (-100 to 0)shad
- Shadows adjustment (0 to +100)
Style Parameters¶
sepia
- Sepia effect intensity (0-100)grayscale
- Convert to grayscale (true/false)monochrome
- Monochrome effect with specified colorduotone
- Duotone effect with "color1,color2" format
Geometry Parameters¶
flip
- Image flipping (h, v, hv)rot
- Rotation in degrees (0-360)pad
- Uniform padding, orpad_top
,pad_right
,pad_bottom
,pad_left
for individual sidesborder
- Border width with optionalborder_color
andborder_radius
Overlay Parameters¶
txt
- Text content withtxt_size
,txt_font
,txt_color
,txt_align
,txt_pad
,txt_line
,txt_line_color
wm_url
- Watermark image URL withwm_pos
,wm_opacity
Auto Optimization¶
auto
- Automatic optimization modes (optimize, format, or both)ch
- Client hints support (width, dpr, savedata)
Example Usage¶
Advanced Image Processing¶
https://yoursite.com/image.jpg?w=800&h=600&fit=crop&crop=faces&blur=1.5&brightness=10&contrast=20&sepia=25&border=5&border_color=white&auto=optimize,format
Responsive Delivery with Effects¶
Text and Watermark Overlay¶
https://yoursite.com/image.jpg?txt=Sample%20Text&txt_size=48&txt_color=white&txt_align=center,middle&wm_url=/logo.png&wm_pos=northeast&wm_opacity=0.7
With Peakhour's comprehensive Image API, you can create sophisticated image processing pipelines that automatically optimize images for performance while applying professional-grade visual enhancements.