Guides

Storages

Amazon S3

  1. Prepare an S3 bucket in any region.

  2. Create an IAM user and attach a policy that allows the user to access objects in the S3 bucket.

     {
         "Version": "2012-10-17",
         "Statement": [
             {
                 "Effect": "Allow",
                 "Action": "s3:GetObject",
                 "Resource": "arn:aws:s3:::{your-bucket-name}/*"
             }
         ]
     }
  3. Generate an access key for the IAM user and configure it in the imagepix application.

Formats

Input Formats

  • JPEG
  • PNG
  • WebP (including animated)
  • GIF (including animated)

Output Formats

  • JPEG
  • PNG
  • WebP (including animated)
  • GIF (including animated)

Features

Fit - Resize images without layout breaking

GET https://{subdomain}.imagepix.app/fit/{width}/{height}/{format}/{quality}/{path}

Fill - Deliver perfectly cropped images

GET https://{subdomain}.imagepix.app/fill/{width}/{height}/{gravity}/{format}/{quality}/{path}
  • Crops extra parts while fitting the specified size.
  • Parameters:
    • subdomain (application’s subdomain)
    • width (1–1920)
    • height (1–1920)
    • format (jpeg, png, webp, gif)
    • quality (1–100)
    • gravity: c, n, e, s, w, ne, se, sw, nw
      • c, n, e, s, and w are the initials of Center, North, East, South, and West, respectively.
    • path (image path in your storage)
  • Example URL: https://demo.imagepix.app/fill/200/200/w/webp/80/logo/landscape.png

Fill Pad - Preserve your full image with background padding

GET https://{subdomain}.imagepix.app/fill_pad/{width}/{height}/{gravity}/{background}/{format}/{quality}/{path}
  • Preserves the full image and fills empty space with a background color.
  • Parameters:
    • subdomain (application’s subdomain)
    • width (1–1920)
    • height (1–1920)
    • format (jpeg, png, webp, gif)
    • quality (1–100)
    • gravity: c, n, e, s, w, ne, se, sw, nw
      • c, n, e, s, and w are the initials of Center, North, East, South, and West, respectively.
    • background: CSS color value
    • path (image path in your storage)
  • Example URL: https://demo.imagepix.app/fill_pad/200/200/c/green/webp/80/logo/landscape.png