Appearance

Getting Started ​

Icefiery is an image CDN and transformation API that lets you:

  • Upload images via REST API
  • Transform images on-the-fly with URL parameters
  • Serve images with a fast CDN
  • Manage projects with team access control
  • Run locally for development with Docker

Quick Start ​

1. Create an Account ​

Sign up at icefiery.com for a free account with:

  • 50 free images
  • 100 free transformations per month
  • 1GB free bandwidth per month

2. Get Your API Keys ​

After login, go to your Default Project:

  1. Go to Upload Keys tab
  2. Copy the key starting with upl_...

3. Upload Your First Image ​

TIP

You can find these commands in the dashboard after logging in, prepopulated with your Upload Key and API Key!

Upload requires two steps - temporary upload, then save permanently:

bash
# Step 1: Upload temporary image
curl -X POST \
  -H "Content-Type: image/jpeg" \
  --data-binary @your-image.jpg \
  https://api.icefiery.com/api/v1/upload-temporary-image/YOUR_UPLOAD_KEY

# Returns: {"temporaryImageUrl": "https://cdn.icefiery.com/res/temporary/tmp_xyz.jpg"}

# Step 2: Save permanently (requires API key)
curl -X POST \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"temporaryImageUrl": "https://cdn.icefiery.com/res/temporary/tmp_xyz.jpg"}' \
  https://api.icefiery.com/api/v1/save-temporary-image

# Returns: {"imageId": "img_abc123", "imageUrl": "https://cdn.icefiery.com/res/img_abc123.jpg"}

INFO

All projects have a list of allowed origins for temporary uploads endpoint, which can be used directly from the browser. The Default Project is initialized with an allowed origin of http://localhost.

4. Transform Your Image ​

Add parameters to the image URL:

# Original image
https://cdn.icefiery.com/res/img_abc123.jpg

# Resize to 300x200
https://cdn.icefiery.com/res/img_abc123.jpg?width=300&height=200

# Convert to WebP format
https://cdn.icefiery.com/res/img_abc123.webp?width=300&height=200

# High quality JPEG
https://cdn.icefiery.com/res/img_abc123.jpg?width=400&quality=95

Transformation Parameters ​

See Transformation Parameters.

Next Steps ​

Need Help? ​

Local Development ​

Run Icefiery locally for development with Docker, see Docker Tutorial.