Proxy Image
Proxy and transform images from decentralized storage protocols like Arweave and IPFS. This endpoint fetches images from ar://, ipfs://, or https:// URLs and optionally resizes and converts them to a target format.
Supported URL formats:
ar://- Arweave URLs (e.g.,ar://abc123...)ipfs://- IPFS URLs (e.g.,ipfs://Qm...)https://- Direct HTTPS URLs
Images are processed using sharp and can be resized and converted to WebP, AVIF, JPEG, or PNG formats. Responses are cached with immutable cache headers.
Overview
The Image Proxy API fetches and transforms images from decentralized storage protocols like Arweave and IPFS. It acts as a proxy that:- Converts
ar://andipfs://URLs to fetchable gateway URLs - Resizes images to specified dimensions without enlargement
- Converts images to optimized formats (WebP, AVIF, JPEG, PNG)
- Returns immutable cache headers for efficient caching
Supported URL Formats
| Protocol | Format | Example |
|---|---|---|
| Arweave | ar:// | ar://abc123xyz... |
| IPFS | ipfs:// | ipfs://QmXyz... |
| HTTPS | https:// | https://arweave.net/abc123... |
Image Transformation
Whenw (width) or h (height) parameters are provided, the image is resized to fit within the specified dimensions using the inside fit strategy, meaning:
- The image will never be enlarged beyond its original size
- Aspect ratio is preserved
- The image fits within the bounding box defined by
wandh
Example Usage
Basic Request
With Resize and Format Conversion
In an HTML Image Element
Query Parameters
The URL of the image to fetch. Supports Arweave (ar://), IPFS (ipfs://), and HTTPS URLs.
Target width in pixels. The image will be resized to fit within this width without enlargement.
1 <= x <= 4096Target height in pixels. The image will be resized to fit within this height without enlargement.
1 <= x <= 4096Image quality (1-100). Higher values produce better quality but larger files.
1 <= x <= 100Output image format.
webp, avif, jpeg, png Response
Processed image returned
The response is of type file.