The image proxy endpoint allows you to fetch and transform images from remote URLs. You can resize, crop, and adjust the quality of images to optimize them for your application's display requirements and performance needs.
Proxy remote image
Fetch and transform an image from a remote URL with various transformation options.
Parameters
The getImage method accepts the following parameters:
| Parameter | Type | Description |
url | string | The URL of the remote image to fetch and transform. Must be a valid HTTP or HTTPS URL. |
width | integer | The width of the output image in pixels. The image will be resized maintaining aspect ratio. Accepts values between 0-4000. |
height | integer | The height of the output image in pixels. The image will be resized maintaining aspect ratio. Accepts values between 0-4000. |
quality | integer | The quality of the output image. Accepts values between 0-100, where 100 is the highest quality. Defaults to 100 if not provided. |
gravity | string | The gravity point for cropping when both width and height are provided. Accepts: center, top-left, top, top-right, left, right, bottom-left, bottom, bottom-right. Defaults to center. |
output | string | The output image format. Supported formats: jpg, jpeg, png, gif, webp, avif, heic. If not provided, uses the original image format. |
Resizing
Resize images to specific dimensions while maintaining aspect ratio. When only width or height is provided, the other dimension is calculated automatically.
Cropping
When both width and height are specified, you can control how the image is cropped using the gravity parameter.
Quality and format
Adjust image quality and output format to optimize file size and performance.
Use cases
Image proxy is commonly used for:
- Responsive images: Generate multiple sizes for different screen sizes and devices
- Thumbnail generation: Create thumbnails from full-size images for galleries and lists
- Format optimization: Convert images to modern formats like WebP or AVIF for better compression
- Performance optimization: Reduce image file sizes while maintaining acceptable quality
- Content delivery: Transform images on-the-fly for CDN delivery and caching
- Secure content serving: Serve untrusted user content securely through Appwrite's trusted proxy with proper SSL certification, protecting your application from mixed content warnings and security vulnerabilities