Skip to main content
Imgix logo
  • Category: images & design
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 53
  • Triggers: 0
  • Slug: IMGIX
  • Version: 20261101_00

Tools

Slug: IMGIX_ADD_ASSET_FROM_ORIGINTool to queue a path from your origin to be added to the Asset Manager. Imports the asset metadata without uploading the asset itself. Use when you need to register an existing origin-hosted file with imgix.

Input Parameters

string
required
The unique identifier of the source where the asset will be added.
string
required
The origin path of the asset to add, e.g., ‘test/sample.jpg’. This path references an existing file on your origin that will be queued for import into the Asset Manager without uploading the file itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_AUTOApply automatic image optimizations using imgix’s auto parameter. Use this tool to automatically optimize images for web delivery. Common use cases: - Reduce file sizes with ‘compress’ for faster page loads - Auto-select modern formats (AVIF/WebP) with ‘format’ based on browser support - Enhance image quality with ‘enhance’ (adjusts brightness, contrast, saturation) - Remove red-eye from portrait photos with ‘redeye’ Multiple options can be combined (e.g., [‘compress’, ‘format’]) for cumulative optimizations. The ‘true’ option is a convenient shorthand that applies ‘enhance’ automatically. Note: This tool works with the imgix Rendering API and requires a valid imgix source domain. For testing, use ‘assets.imgix.net’ with paths like ‘examples/kingfisher.jpg’.

Input Parameters

array
required
List of automatic optimization operations to apply. Values can be combined. Options: ‘compress’ (reduces file size via aggressive compression), ‘enhance’ (auto-adjusts brightness, contrast, saturation), ‘format’ (auto-selects optimal format like AVIF/WebP based on browser support), ‘redeye’ (removes red-eye from detected faces), ‘true’ (shorthand that applies enhance and conditionally redeye if crop=faces is set).
string
required
Path to the image asset within the source. For the public demo source (assets.imgix.net), example paths include ‘examples/kingfisher.jpg’, ‘examples/blueberries.jpg’, ‘examples/pione.jpg’, ‘examples/butterfly.jpg’.
string
required
Imgix source domain. Use your configured source subdomain (e.g., ‘my-source.imgix.net’) or the public demo source ‘assets.imgix.net’ for testing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_BLENDTool to overlay an image, text, or color onto a base image using imgix blending parameters. Use after specifying the base image URL and blend parameters to composite layers.

Input Parameters

string
URL-encoded overlay URL (image or text), absolute or relative.
string
URL-safe Base64-encoded overlay URL (image or text).
number
Overlay height in pixels (>1) or ratio of base height (0.0-1.0)
number
Overlay width in pixels (>1) or ratio of base width (0.0-1.0)
integer
Horizontal offset in pixels from the left edge
integer
Vertical offset in pixels from the top edge
string ("clamp" | "clip" | "crop" | "max" | "scale")
How the overlay is fit into its blend_w/blend_h box
integer
Padding in pixels around the overlay when alignment is used
string
When blend_fit=‘crop’, crop focus: top, bottom, left, right, faces; CSV
string ("normal" | "darken" | "multiply" | "burn" | "lighten" | "screen" | "dodge" | "overlay" | "softlight" | "hardlight" | "difference" | "exclusion" | "color" | "hue" | "saturation" | "luminosity")
How the overlay interacts with the base image.
string
If ‘inherit’, overlay inherits base image sizing/cropping
string
Overlay alignment: top, middle, bottom, left, center, right or ‘horizontal,vertical’.
integer
Overlay transparency (0 transparent, 100 opaque).
string
Solid color overlay; accepts keywords or hex strings (3/4/6/8-digit AARRGGBB).
string
required
The URL of the base image to which the overlay will be applied

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_BLEND_ALIGNTool to align the overlay relative to the base image when blending. Use after constructing a base Imgix URL to specify horizontal and vertical alignment (e.g., ‘left,top’).

Input Parameters

string ("top" | "middle" | "bottom")
Vertical alignment of the overlay relative to the base image
string
required
The Imgix image URL to which the blend-align parameter will be applied
string ("left" | "center" | "right")
Horizontal alignment of the overlay relative to the base image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_BLEND_COLORConstruct an image URL with a solid color overlay using a CSS keyword or hex color. Optional blend mode and alpha settings can also be added.

Input Parameters

string
required
Source image URL
string ("normal" | "darken" | "multiply" | "burn" | "lighten" | "screen" | "dodge" | "overlay" | "softlight" | "hardlight" | "difference" | "exclusion" | "color" | "hue" | "saturation" | "luminosity")
How the color blends with the image; default is ‘overlay’
integer
Overlay transparency from 0 (transparent) to 100 (opaque)
string
required
Color keyword or 3-/4-/6-/8-digit hex; for hex, prefix with ’#’ optional; 4/8-digit include alpha channel

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_BLEND_XPosition an overlay image horizontally on a base image using imgix’s blend-x parameter. Use this tool when you need to place an overlay (image or color) at a specific horizontal offset from the left edge of the base image. This is useful for creating watermarks, badges, or composite images where precise positioning is required. Note: The blend-x parameter only affects image overlays. Color overlays always cover the entire image regardless of this setting.

Input Parameters

string
required
Overlay image URL (must also be on an imgix-enabled domain) or a hex color code (e.g., ‘FF0000’ for red). This enables blending on the base image.
integer
Horizontal offset in pixels from the left edge of the base image where the blend overlay will be positioned. Defaults to 0 (left edge). Only applies to image overlays, not color overlays.
string
required
Base image URL hosted on an imgix source (e.g., your-source.imgix.net/path/to/image.jpg). The URL should not contain existing query parameters as they will be overwritten.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_BORDERTool to draw a border around an image. Use when you need to overlay a border without resizing.

Input Parameters

string
required
Border color as a CSS keyword or hexadecimal value (3/4/6/8-digit), e.g., ‘red’, ‘FF0000’, or ‘80FF0000’
integer
required
Border thickness in pixels; must be a positive integer.
string
required
Path to the image within the source, e.g., ‘images/pic.jpg’; omit leading slash
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_BRITool to adjust image brightness. Use when you need to modify an image’s brightness level (−100 to 100) by supplying your source domain and asset path.

Input Parameters

number
Brightness adjustment in percent, between -100 (darkest) and 100 (brightest). Default is 0 (no change).
string
required
Imgix source domain (e.g., ‘my-source’). Do not include ‘https://’ or trailing slash.
string
required
Path to the image asset on your Imgix source (e.g., ‘photos/image.jpg’). No leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CANCEL_UPLOAD_SESSIONTool to cancel an Imgix Asset Manager upload session. Use when you need to abort an in-progress or abandoned upload flow and clean up the session.

Input Parameters

string
required
The identifier of the Source containing the upload session.
string
required
The unique identifier of the upload session to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CHFetch an Imgix image with selected Client Hints options for Width, DPR, or Save-Data and return it as a downloadable file.

Input Parameters

array
required
List of Client Hints tokens to opt into. Allowed values: ‘Width’, ‘DPR’, ‘Save-Data’. Overrides ‘w’ and ‘dpr’ URL params; ‘Save-Data’ enforces q=45 and may change output format.
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’; omit leading slash
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CLOSE_UPLOAD_SESSIONTool to close an Imgix Asset Manager upload session after the client uploads to the presigned URL. Use after uploading a file to expedite asset processing. Closing is strongly recommended by imgix.

Input Parameters

string
required
The Source identifier for the upload session.
string
required
The upload session identifier (UUID format) to close.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CONTool to adjust image contrast. Use when you need to modify an image’s contrast level (−100 to 100).

Input Parameters

number
Contrast adjustment in percent, between -100 (lowest contrast) and 100 (highest contrast). Default is 0 for no change.
string
required
Imgix source domain (e.g., ‘my-source’). Do not include ‘https://’ or trailing slash.
string
required
Path to the image asset on your Imgix source (e.g., ‘photos/image.jpg’). No leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CREATE_IMGIX_SOURCETool to create and deploy a new imgix Source. Use when you need to add a new image source with deployment configuration for S3, Web Folder, Web Proxy, GCS, Azure, or S3-compatible storage. Requires source name and deployment details with type-specific credentials and settings.

Input Parameters

object
required
Source data to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CREATE_UPLOAD_SESSIONTool to create an Imgix Asset Manager upload session and return a presigned URL for client-side upload. Use when you need to upload a new image to a storage-backed imgix Source without requiring external hosting. Client performs HTTP PUT of file bytes to the presigned URL, then calls IMGIX_CLOSE_UPLOAD_SESSION to finalize.

Input Parameters

string
required
The Source ID where the asset will be uploaded. Must be a storage-backed source (S3, GCS, or Azure).
string
required
The destination path for the asset within the source, e.g., ‘images/photo.jpg’. This path will be used in subsequent imgix transformations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_CSTool to set or strip output color space/profile on an Imgix image. Use when optimizing compatibility and file size (e.g., cs=strip for smaller metadata).

Input Parameters

string ("origin" | "srgb" | "adobergb1998" | "tinysrgb" | "strip")
Color space of the output image. Accepted values: ‘origin’, ‘srgb’, ‘adobergb1998’, ‘tinysrgb’, ‘strip’. If omitted, uses ‘origin’.
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’; omit leading slash
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’; exclude protocol

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_DLDownload an asset from an Imgix source with optional custom filename. Use this tool when you need to: - Download images or assets from an Imgix CDN source - Force a specific download filename (via ‘dl’ parameter) - Download assets with special character filenames (via ‘dl64’ parameter) The asset is fetched from the Imgix CDN and returned as a downloadable file reference. If neither ‘dl’ nor ‘dl64’ is specified, the original filename from the path is used.

Input Parameters

string
Desired filename for the downloaded file. When provided, the browser will prompt to save the file with this name instead of the original filename. Mutually exclusive with dl64.
string
Base64-encoded (URL-safe) filename for download. Use this when the filename contains special characters that need URL encoding. Mutually exclusive with dl. Example: ‘bXktaW1hZ2UuanBn’ is base64 for ‘my-image.jpg’.
string
required
Path to the asset within the source, relative to the source root. Do not include the domain or leading ‘https://’. Example: ‘images/photo.jpg’ or ‘folder/subfolder/image.png’.
string
required
Imgix source domain or subdomain for the asset. This is typically in the format ‘your-source.imgix.net’ or a custom domain configured in your Imgix account. Use IMGIX_LIST_SOURCES to discover available source domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_DPITool to embed DPI (dots-per-inch) metadata for print output on an Imgix-rendered image. Use when preparing images for print to set accurate DPI. Supports JPEG and PNG only.

Input Parameters

string ("jpg" | "png")
Optional. Convert the image to this format before setting DPI (only ‘jpg’ or ‘png’).
integer
required
Dots per inch (DPI) to embed in the image Exif header; integer ≥1. Only applies to JPEG and PNG images.
string
required
Imgix source domain without protocol (e.g., ‘my-source’). Do not include ‘https://’ or trailing slash.
string
required
Asset path on your Imgix source (e.g., ‘photos/image.jpg’). Do not include leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_DPRTool to set device pixel ratio for an Imgix image. Use when rendering at specific display densities to ensure correct sharpness. Example: ‘dpr=2&w=500&h=300’ doubles resolution relative to dimensions.

Input Parameters

integer
Desired output height in pixels (integer ≥ 1). At least one of width or height is required.’
integer
Desired output width in pixels (integer ≥ 1). At least one of width or height is required.’
number
Device pixel ratio controlling image output density. Default is 1; must be ≥ 0 and ≤ 5. Requires width and/or height to take effect.
string
required
Imgix source domain (e.g., ‘my-source’). Do not include ‘https://’ or trailing slash.’
string
required
Path to the image asset on your Imgix source (e.g., ‘photos/image.jpg’). No leading slash.‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_EXPIRESTool to append an expiration parameter to an Imgix URL so it returns 404 after a given time. Use when you want the image URL to stop serving beyond a specific UNIX timestamp.

Input Parameters

string
required
Asset path within the source (e.g., “images/photo.jpg”). Exclude leading slash.
integer
required
Absolute UNIX timestamp (seconds since epoch) after which the URL will return 404
string
required
Imgix source domain (e.g., “my-source.imgix.net”). Exclude protocol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_FITTool to control how an image fits target dimensions after resizing. Use when specifying width, height, and fit behavior.

Input Parameters

string
required
Output height in pixels (1-8192) or ratio (0.0-1.0) of source height
string
required
Output width in pixels (1-8192) or ratio (0.0-1.0) of source width
string ("clamp" | "clip" | "crop" | "facearea" | "fill" | "fillmax" | "max" | "min" | "scale")
required
Specifies how to fit the image within the target dimensions. One of: clamp, clip, crop, facearea, fill, fillmax, max, min, scale.
number
Padding around detected faces as fraction of face bounding box when fit=‘facearea’
integer
Select which detected face to prioritize when fit=‘facearea’
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’ (omit leading slash)
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’ (exclude protocol)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_FMTool to choose output file format for the rendered asset. Use after specifying the asset path when you need to convert its format.

Input Parameters

string ("avif" | "gif" | "jp2" | "jpg" | "json" | "jxr" | "pjpg" | "mp4" | "png" | "png8" | "png32" | "webm" | "webp" | "blurhash")
required
Output format to convert the asset to. Valid values: avif, gif, jp2, jpg, json, jxr, pjpg, mp4, png, png8, png32, webm, webp, blurhash.
string
required
Asset path within the source (e.g., “images/photo.jpg”)
string
required
Imgix source domain (e.g., “my-source.imgix.net”)
boolean
Only valid when fm=‘webp’ or fm=‘jxr’. Set to true to request lossless WebP or JPEG XR delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_FORCE_ASPECT_RATIOTool to force a target aspect ratio on an Imgix image. Use when a specific W:H frame is needed after choosing fit=crop or fit=fill. Example: ‘ar=16:9&fit=crop&w=800’ yields a 16:9, 800px-wide URL.

Input Parameters

string
Desired height in pixels (integer) or as a ratio (0.0-1.0). If omitted and ‘w’ is set, ‘h’ is auto-calculated.
string
Desired width in pixels (integer) or as a ratio (0.0-1.0). If omitted and ‘h’ is set, ‘w’ is auto-calculated.
string
required
Target aspect ratio in ‘W:H’ format. Use integers or decimals, e.g., ‘16:9’, ‘4:3’, ‘1.5:1’.
string ("crop" | "fill")
required
How the image fits the target ratio. Must be ‘crop’ or ‘fill’.
string ("top" | "bottom" | "left" | "right" | "faces" | "focalpoint" | "edges" | "entropy")
When ‘fit=crop’, controls alignment of the crop box. Defaults to center if unset.
string ("solid" | "blur" | "gradient" | "gen")
When ‘fit=fill’, determines how excess space is filled. Options: ‘solid’, ‘blur’, ‘gradient’, ‘gen’.
string
required
Path to the image on your Imgix source, e.g., ‘images/photo.jpg’. Exclude leading slash.
string
Color for solid fill, e.g., ‘#ff0000’ or ‘red’. Only used when ‘fill=solid’.
string
required
Your Imgix source domain, e.g., ‘my-source.imgix.net’. Exclude protocol (‘http://’ or ‘https://’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_GET_SOURCETool to retrieve details for a single imgix Source by its ID. Returns the source configuration including deployment status, type, and settings.

Input Parameters

string
required
The unique identifier of the source to retrieve.
string
Comma-separated list of Source fields to return; use dot notation for nested fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_GET_UPLOAD_SESSION_STATUSTool to retrieve the status of an Imgix Asset Manager upload session. Use when you need to check the current state (PENDING/CLOSED/COMPLETE/CANCELED) of an upload session for polling or verification after client PUT and/or after closing.

Input Parameters

string
required
The source identifier where the upload session exists.
string
required
The unique identifier for the upload session (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_HFetch an Imgix image with its output height set in pixels or as a ratio of the source height. Returns the rendered image as a downloadable file.

Input Parameters

string
required
Height of the output image. Provide a positive integer for pixel height (1-8192), or a float >0.0 and ≤1.0 to specify a ratio of the source height.
string
required
Imgix source domain (e.g., ‘my-source’). Do not include protocol or trailing slash.
string
required
Path to the image on your Imgix source (e.g., ‘photos/image.jpg’); omit leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_HIGHTool to adjust highlight tonal mapping (−100 to 0). Use when preserving detail in bright areas of an image.

Input Parameters

number
Highlight tonal mapping adjustment in percent, between -100 (reduce highlights most) and 0 (no change).
string
required
Imgix source domain (e.g., ‘my-source’). Do not include ‘https://’ or trailing slash.
string
required
Path to the image asset on your Imgix source (e.g., ‘photos/image.jpg’). No leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_LIST_ASSETSTool to retrieve a paginated list of assets in an imgix Source. Use when you need to list, filter, or search assets with cursor-based pagination and sorting.

Input Parameters

string
Field to sort by. Supported fields: date_created, date_modified, file_size. Prefix with ’-’ for descending order (e.g., ‘-date_created’).
string
required
The unique identifier of the source to list assets from.
integer
Number of items per page. Must be ≥ 1.
string
Comma-separated tag values to filter by (AND logic).
string
Cursor for pagination. Use the ‘next’ cursor value from a previous response to retrieve the next page.
string
Hex color code without the ’#’ symbol to filter by dominant color.
string
Search keyword to filter assets across multiple fields including origin path and description.
string
Comma-separated category values to filter by (AND logic).
string
Filter by number of faces detected. Single integer for exact match, or range format: ‘1:3’ (1 to 3), ‘1:’ (1 or more), ‘:2’ (up to 2).
boolean
Filter for animation assets (videos or GIFs). Set to true to return only animations.
string ("IMAGE" | "ANIMATION" | "DOCUMENT" | "VECTOR")
Filter by asset type.
string
Filter by asset path relative to source prefix.
string
Filter by racy content warning level (0-5 scale). Single integer or range format: ‘1:3’, ‘1:’, ‘:2’.
string
Filter by adult content warning level (0-5 scale). Single integer or range format: ‘1:3’, ‘1:’, ‘:2’.
string
Filter by spoof content warning level (0-5 scale). Single integer or range format: ‘1:3’, ‘1:’, ‘:2’.
string
Filter by medical content warning level (0-5 scale). Single integer or range format: ‘1:3’, ‘1:’, ‘:2’.
string
Filter by violence content warning level (0-5 scale). Single integer or range format: ‘1:3’, ‘1:’, ‘:2’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_LIST_REPORTSRetrieve a list of available reports for an Imgix account, with optional filters and sorting, for access to analytics and usage information.

Input Parameters

string
Sort by field. Supported fields: period_end, period_start, report_key, report_type. Prefix with ’-’ for descending order.
string
Comma-separated list of report fields to return (sparse fieldsets). Use dot notation for nested fields.
boolean
Filter by completion status. True returns only completed reports, False returns only incomplete reports.
string ("cdn_logs" | "image_analytics" | "mild_errors" | "source_analytics")
Filter by report type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_LIST_SOURCESTool to list all Sources for an account. Use when you need to retrieve and paginate through sources with optional sorting and filtering.

Input Parameters

string
Comma-separated fields to sort by; prepend ’-’ for descending. Supported: date_deployed, enabled, name.
integer
Page size; must be ≥ 1.
string
Filter by Source name (ANDed with other filters).
integer
Zero-indexed page number.
string
Comma-delimited list of Source fields to return; use dot notation for nested fields.
boolean
Filter by enabled status.
string ("azure" | "gcs" | "s3" | "webfolder" | "webproxy" | "s3_compatible")
Filter by deployment type.
string
S3-Compatible region filter.
string
S3 bucket name filter.
string
GCS bucket name filter.
string
S3-Compatible bucket name filter.
string
Azure container name filter.
string
Custom domains filter.
string
Imgix subdomains filter.
string
S3-Compatible storage provider filter.
string
Web Folder base URL filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MARK_BASETool to set the base URL prepended to the watermark image path. Use when you need to host watermark assets on a custom domain or CDN.

Input Parameters

string
required
Fully qualified base URL to prepend to the watermark image path. Must include scheme, e.g., ‘https://cdn.example.com’
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’; omit leading slash
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MARK_FITTool to set how a watermark fits its target dimensions. Use when applying a watermark and you need control over fitting behavior (e.g., selecting ‘scale’). For ‘crop’, ensure ‘mark-w’ and ‘mark-h’ are also provided.

Input Parameters

string ("clip" | "crop" | "max" | "scale")
Controls how the watermark fits within the specified dimensions. Allowed values: - clip: preserve aspect ratio within bounds (default); - crop: fill bounds exactly (requires mark-w and mark-h); - max: fit within bounds without upscaling; - scale: force exact target dimensions.
string
required
The Imgix URL to which the watermark fit mode will be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MARK_HTool to set watermark height on an Imgix URL in pixels or as a ratio of the watermark source. Use when adjusting overlay height while preserving aspect ratio.

Input Parameters

string
required
Overlay source URL for the watermark image or text overlay.
string
required
Watermark height. Provide a positive integer >1 and <=2000 to specify pixel height, or a float between 0.0 and 1.0 inclusive to specify a ratio of the watermark source height.
string
required
Existing Imgix URL to which the watermark height parameter will be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MARK_PADSet pixel padding between a watermark and the image edge or between tiled watermarks by returning an Imgix URL with the padding parameter applied.

Input Parameters

string
required
Full URL of the source image (including any existing query parameters).
integer
Number of pixels of padding between watermark and image edge; also between tiled watermark images. Must be an integer ≥ 0. Defaults to 5 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MARK_WSet watermark width in an Imgix image URL and return the modified URL.

Input Parameters

string
required
Watermark width. Specify an integer ≥1 to set an absolute pixel width, or a float >0 and ≤1 to set a ratio of the watermark source’s width.
string
required
The Imgix URL to which the watermark width will be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MASKTool to apply a mask to an image. Use when needing rounded corners, ellipse shapes, or image-based masks.

Input Parameters

string
Mask type: ‘corners’, ‘ellipse’, or an image URL; URL or comma-separated values must be URL-encoded
string
Base64-encoded mask; use when encoding URLs or comma-separated values
string
Background color for masked areas; accepts CSS keywords or hex (e.g., ‘FF0000’ or ‘red’)
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’ (omit leading slash)
string
Corner radius in pixels; integer or comma-separated list of up to 4 values, used when mask=‘corners’
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’ (exclude protocol)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MAX_HConstrain the maximum height of an imgix image. This tool applies fit=crop along with the max-h parameter to ensure images do not exceed the specified height. Ideal for vertically-scrolling feeds or galleries where user-uploaded images may have unpredictable heights. Returns a downloadable image URL.

Input Parameters

integer
required
Maximum height in pixels for the output image. The image will be cropped (with fit=crop) to ensure its height does not exceed this value. Useful for vertically-scrolling feeds to prevent excessively tall images.
string
required
Path to the image file within the source (e.g., ‘photos/hero.jpg’). Leading slashes are automatically handled.
string
required
Imgix source domain hostname without protocol (e.g., ‘my-source.imgix.net’ or ‘assets.imgix.net’). Do NOT include ‘https://’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_MAX_WRequest an Imgix image with a maximum output width and return it as a downloadable file. The max-w parameter works with fit=crop, but this action does not include fit=crop in its request.

Input Parameters

integer
required
Maximum allowed output width in pixels (works only with fit=crop). Must be between 1 and 8192.
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’ (omit leading slash)
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’ (exclude protocol)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_PALETTEExtract a color palette from an Imgix image in CSS or JSON form for analyzing its dominant colors.

Input Parameters

integer
Number of colors to include in the palette (0-16). Default 6.
string
CSS class prefix when palette=‘css’. Ignored for JSON.
string ("css" | "json")
Output format: ‘json’ for structured data, ‘css’ for stylesheet.
string
URL signature (s=…) if secure URLs are enabled.
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’. Omit leading slash.
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’. Do not include protocol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_PREFIXTool to set class-name prefix for CSS palette output. Use when customizing CSS selectors for color-palette styling.

Input Parameters

integer
Number of colors to include in the palette; default is 6; valid range 0–16.
string
CSS class name prefix to use instead of the default ‘image’; ignored when palette=‘json’.
string ("css" | "json")
Output format: ‘css’ to receive a CSS stylesheet, ‘json’ for JSON palette output; prefix is only applied when ‘css’.
string
required
Path to the image within the source, e.g., ‘examples/pione.jpg’. May include or omit leading slash.
string
required
Imgix source domain (hostname), e.g., ‘assets.imgix.net’. Do not include protocol.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_PURGE_IMGIX_ASSETTool to purge an asset from the imgix cache. Use when you need to invalidate cached versions of an image and force imgix to fetch a fresh version from origin on the next request.

Input Parameters

string
required
The full imgix URL of the asset to purge from cache. Must be a valid imgix URL including the subdomain (e.g., https://your-source.imgix.net/path/to/image.jpg). After purge, the next request will fetch a fresh version from origin.
string
Optional Source ID to scope the purge operation to a specific source.
boolean
If true, purges only sub-images (specific variants/transformations) of the asset. If false or omitted, purges the entire asset including all variants.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_QTool to set output quality for lossy formats. Use when adjusting image compression quality for lossy image delivery.

Input Parameters

integer
Output quality for lossy formats (jpg, pjpg, webp, avif, jxr). Valid range 0-100; default 75.
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’ (omit leading slash)
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’ (exclude protocol)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_RECTTool to select a source-image rectangle region in Imgix before other resizing. Use when you need to crop a specific region (x,y,w,h) of the source image.

Input Parameters

string
required
Height of the rectangle: integer pixels, fraction (0.0-1.0), or ‘full’ for full image height.
string
required
Width of the rectangle: integer pixels, fraction (0.0-1.0), or ‘full’ for full image width.
string
required
Horizontal offset for the rectangle origin: integer pixels, fraction (0.0-1.0), or one of ‘left’,‘center’,‘right’.
string
required
Vertical offset for the rectangle origin: integer pixels, fraction (0.0-1.0), or one of ‘top’,‘middle’,‘bottom’.
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’; omit leading slash.
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’; exclude protocol (‘http://’ or ‘https://’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_ROTTool to rotate an image on Imgix. Use when you need to apply a counter-clockwise rotation (0–359°) with optional mode control.

Input Parameters

integer
Degrees to rotate the image counter-clockwise. Must be between 0 and 359.
string
required
Asset path within the source (e.g., “images/photo.jpg”). Exclude leading slash.
string
required
Imgix source domain (e.g., “my-source.imgix.net”). Exclude protocol prefix.
string ("pivot" | "straighten")
When set, controls rotation mode: ‘pivot’ shows full image; ‘straighten’ zooms and crops.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_ROT_TYPESet rotation behavior to pivot or straighten on an Imgix image URL that already has a rotation parameter, and return the modified URL.

Input Parameters

string ("pivot" | "straighten")
required
Type of rotation behavior: pivot displays the entire image without cropping; straighten zooms in and crops to straighten an image.
string
required
Full Imgix image URL to which the rot-type parameter will be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXTTool to render a single-line UTF-8 text overlay on an image. Use when you need simple text captions.

Input Parameters

string
Text string to render (UTF-8 supported, including emoji)
string
URL-safe Base64 encoded text string. Use this instead of ‘txt’ when your text contains special characters that might break URLs. Omit the ’=’ padding from the Base64 value.
string
required
URL of the source image to overlay text onto

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_ALIGNRequest an Imgix image with vertical and horizontal text-overlay alignment parameters and return the image as a downloadable file.

Input Parameters

string ("top" | "middle" | "bottom")
Vertical alignment of the text overlay: ‘top’, ‘middle’, or ‘bottom’
string ("left" | "center" | "right")
Horizontal alignment of the text overlay: ‘left’, ‘center’, or ‘right’
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’; omit leading slash
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’; exclude protocol

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_COLORSet text-overlay color in an Imgix image URL using a CSS color keyword, hex code, or encoded color value, and return the modified URL.

Input Parameters

string
required
Source Imgix URL or source domain with path
string
CSS color keyword or 3-/4-/6-/8-digit hex (RGB/ARGB/RRGGBB/AARRGGBB). 4-/8-digit hex supports alpha transparency. Default is opaque black ‘000’.
string
URL-safe Base64-encoded color value. Use when color contains special characters. Mutually exclusive with txt_color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_FONTRequest an Imgix image with a font family and style for overlay text and return it as a downloadable file. Supports CSS font categories and optional bold or italic flags.

Input Parameters

string
required
Defines the typeface and style for overlay text. Accepts CSS categories: serif, sans-serif, monospace, cursive, fantasy, or explicit font names. To add bold and/or italic, append comma-separated flags (e.g., ‘sans-serif,bold,italic’).
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’ (omit leading slash)
boolean
If true, the font value will be URL-safe Base64 encoded and sent in the ‘txt-font64’ parameter instead of ‘txt-font’.
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’ (exclude protocol)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_LINESet the outline width for overlay text in an Imgix image URL, returning the modified URL.

Input Parameters

integer
required
Width of the outline to draw around overlay text in pixels. 0 draws no outline (default). Outline is drawn inside text edges.
string
required
Existing Imgix URL to which the text outline width parameter will be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_LINE_COLORApply an outline color to text overlays on Imgix images. The text outline must first be enabled using the txt-line parameter (outline width > 0). This action fetches and returns the rendered image with the specified outline color applied.

Input Parameters

string
required
Color for the text outline. Accepts CSS color keywords (e.g., ‘red’, ‘blue’, ‘black’) or hex codes in these formats: 3-digit RGB (fff), 4-digit ARGB (a0f0), 6-digit RRGGBB (ff0000), or 8-digit AARRGGBB (80ff0000 for semi-transparent red).
boolean
If true, Base64-encode the color value and use ‘txt-line-color64’ parameter. Use this when the color value contains special characters that need URL encoding.
string
required
Imgix image URL with text overlay parameters. Should include ‘txt’ (or ‘txt64’) for text content and ‘txt-line’ for outline width. The outline color set by this action will only be visible when txt-line > 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_SHADFetch an Imgix image with an optional text shadow strength from 0 to 10 and return it as a downloadable file. The shadow is visible only with text overlay parameters.

Input Parameters

integer
Strength of text shadow (0-10). 0 means no shadow, 10 is maximum shadow intensity. Note: This parameter only has a visible effect when used in combination with text overlay parameters (txt). Use this to add depth to text overlays on images.
string
required
Path to the image within the source, e.g., ‘examples/photo.jpg’. Leading slash is optional and will be stripped.
string
required
Imgix source domain (hostname), e.g., ‘assets.imgix.net’. Must not include protocol (http:// or https://).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_TXT_SIZEFetch an Imgix image with a text font size in pixels, defaulting to 12px. Returns the final image URL and, when available, a downloadable image.

Input Parameters

integer
Font size of the overlay text in pixels; must be ≥ 1
string
required
Path to the image within the source, e.g., ‘images/photo.jpg’; omit leading slash
string
required
Imgix source domain (hostname), e.g., ‘example-source.imgix.net’; exclude protocol

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMGIX_UPDATE_SOURCEUpdate an existing Imgix Source’s name, enabled status, or deployment configuration. Deployment changes trigger automatic redeployment.

Input Parameters

object
required
JSON:API data object containing the source updates.
string
required
The unique identifier of the source to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not