> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Imgix

> imgix is a real-time image processing and delivery service that enables developers to optimize, transform, and deliver images efficiently.

![Imgix logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/imgix.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=c9a9b5471e930a7e1e73f221efc775fb)

* **Category:** images & design
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 53
* **Triggers:** 0
* **Slug:** `IMGIX`
* **Version:** 20261101\_00

## Tools

> [accordion] IMGIX\_ADD\_ASSET\_FROM\_ORIGIN
>
> **Slug:** `IMGIX_ADD_ASSET_FROM_ORIGIN`
>
> Tool 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
>
> **source\_id** `string` *required*
>
> The unique identifier of the source where the asset will be added.
>
> **origin\_path** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Imgix Auto Optimization
>
> **Slug:** `IMGIX_AUTO`
>
> Apply 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
>
> **auto** `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).
>
> **path** `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'.
>
> **source** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Blend Overlay
>
> **Slug:** `IMGIX_BLEND`
>
> Tool 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
>
> **blend** `string`
>
> URL-encoded overlay URL (image or text), absolute or relative.
>
> **blend64** `string`
>
> URL-safe Base64-encoded overlay URL (image or text).
>
> **blend\_h** `number`
>
> Overlay height in pixels (>1) or ratio of base height (0.0-1.0)
>
> **blend\_w** `number`
>
> Overlay width in pixels (>1) or ratio of base width (0.0-1.0)
>
> **blend\_x** `integer`
>
> Horizontal offset in pixels from the left edge
>
> **blend\_y** `integer`
>
> Vertical offset in pixels from the top edge
>
> **blend\_fit** `string ("clamp" | "clip" | "crop" | "max" | "scale")`
>
> How the overlay is fit into its blend\_w/blend\_h box
>
> **blend\_pad** `integer`
>
> Padding in pixels around the overlay when alignment is used
>
> **blend\_crop** `string`
>
> When blend\_fit='crop', crop focus: top, bottom, left, right, faces; CSV
>
> **blend\_mode** `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.
>
> **blend\_size** `string`
>
> If 'inherit', overlay inherits base image sizing/cropping
>
> **blend\_align** `string`
>
> Overlay alignment: top, middle, bottom, left, center, right or 'horizontal,vertical'.
>
> **blend\_alpha** `integer`
>
> Overlay transparency (0 transparent, 100 opaque).
>
> **blend\_color** `string`
>
> Solid color overlay; accepts keywords or hex strings (3/4/6/8-digit AARRGGBB).
>
> **base\_image\_url** `string` *required*
>
> The URL of the base image to which the overlay will be applied
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Imgix Blend Align
>
> **Slug:** `IMGIX_BLEND_ALIGN`
>
> Tool 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
>
> **vertical** `string ("top" | "middle" | "bottom")`
>
> Vertical alignment of the overlay relative to the base image
>
> **image\_url** `string` *required*
>
> The Imgix image URL to which the blend-align parameter will be applied
>
> **horizontal** `string ("left" | "center" | "right")`
>
> Horizontal alignment of the overlay relative to the base image
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Blend Color Over Image
>
> **Slug:** `IMGIX_BLEND_COLOR`
>
> Construct 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
>
> **image\_url** `string` *required*
>
> Source image URL
>
> **blend\_mode** `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'
>
> **blend\_alpha** `integer`
>
> Overlay transparency from 0 (transparent) to 100 (opaque)
>
> **blend\_color** `string` *required*
>
> Color keyword or 3-/4-/6-/8-digit hex; for hex, prefix with '#' optional; 4/8-digit include alpha channel
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Imgix Blend X Position
>
> **Slug:** `IMGIX_BLEND_X`
>
> Position 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
>
> **blend** `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.
>
> **blend\_x** `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.
>
> **image\_url** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Draw Image Border
>
> **Slug:** `IMGIX_BORDER`
>
> Tool to draw a border around an image. Use when you need to overlay a border without resizing.
>
> #### Input Parameters
>
> **color** `string` *required*
>
> Border color as a CSS keyword or hexadecimal value (3/4/6/8-digit), e.g., 'red', 'FF0000', or '80FF0000'
>
> **width** `integer` *required*
>
> Border thickness in pixels; must be a positive integer.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/pic.jpg'; omit leading slash
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Adjust Image Brightness
>
> **Slug:** `IMGIX_BRI`
>
> Tool 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
>
> **bri** `number`
>
> Brightness adjustment in percent, between -100 (darkest) and 100 (brightest). Default is 0 (no change).
>
> **source** `string` *required*
>
> Imgix source domain (e.g., 'my-source'). Do not include 'https\://' or trailing slash.
>
> **asset\_path** `string` *required*
>
> Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_CANCEL\_UPLOAD\_SESSION
>
> **Slug:** `IMGIX_CANCEL_UPLOAD_SESSION`
>
> Tool 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
>
> **source\_id** `string` *required*
>
> The identifier of the Source containing the upload session.
>
> **session\_id** `string` *required*
>
> The unique identifier of the upload session to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_CH
>
> **Slug:** `IMGIX_CH`
>
> Fetch an Imgix image with selected Client Hints options for Width, DPR, or Save-Data and return it as a downloadable file.
>
> #### Input Parameters
>
> **ch** `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.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_CLOSE\_UPLOAD\_SESSION
>
> **Slug:** `IMGIX_CLOSE_UPLOAD_SESSION`
>
> Tool 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
>
> **source\_id** `string` *required*
>
> The Source identifier for the upload session.
>
> **session\_id** `string` *required*
>
> The upload session identifier (UUID format) to close.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Adjust Image Contrast
>
> **Slug:** `IMGIX_CON`
>
> Tool to adjust image contrast. Use when you need to modify an image's contrast level (−100 to 100).
>
> #### Input Parameters
>
> **con** `number`
>
> Contrast adjustment in percent, between -100 (lowest contrast) and 100 (highest contrast). Default is 0 for no change.
>
> **source** `string` *required*
>
> Imgix source domain (e.g., 'my-source'). Do not include 'https\://' or trailing slash.
>
> **asset\_path** `string` *required*
>
> Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_CREATE\_IMGIX\_SOURCE
>
> **Slug:** `IMGIX_CREATE_IMGIX_SOURCE`
>
> Tool 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
>
> **data** `object` *required*
>
> Source data to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_CREATE\_UPLOAD\_SESSION
>
> **Slug:** `IMGIX_CREATE_UPLOAD_SESSION`
>
> Tool 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
>
> **source\_id** `string` *required*
>
> The Source ID where the asset will be uploaded. Must be a storage-backed source (S3, GCS, or Azure).
>
> **origin\_path** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_CS
>
> **Slug:** `IMGIX_CS`
>
> Tool 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
>
> **cs** `string ("origin" | "srgb" | "adobergb1998" | "tinysrgb" | "strip")`
>
> Color space of the output image. Accepted values: 'origin', 'srgb', 'adobergb1998', 'tinysrgb', 'strip'. If omitted, uses 'origin'.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_DL
>
> **Slug:** `IMGIX_DL`
>
> Download 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
>
> **dl** `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.
>
> **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'.
>
> **path** `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'.
>
> **source** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Adjust Image DPI
>
> **Slug:** `IMGIX_DPI`
>
> Tool 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
>
> **fm** `string ("jpg" | "png")`
>
> Optional. Convert the image to this format before setting DPI (only 'jpg' or 'png').
>
> **dpi** `integer` *required*
>
> Dots per inch (DPI) to embed in the image Exif header; integer ≥1. Only applies to JPEG and PNG images.
>
> **source** `string` *required*
>
> Imgix source domain without protocol (e.g., 'my-source'). Do not include 'https\://' or trailing slash.
>
> **asset\_path** `string` *required*
>
> Asset path on your Imgix source (e.g., 'photos/image.jpg'). Do not include leading slash.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Device Pixel Ratio
>
> **Slug:** `IMGIX_DPR`
>
> Tool 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
>
> **h** `integer`
>
> Desired output height in pixels (integer ≥ 1). At least one of width or height is required.'
>
> **w** `integer`
>
> Desired output width in pixels (integer ≥ 1). At least one of width or height is required.'
>
> **dpr** `number`
>
> Device pixel ratio controlling image output density. Default is 1; must be ≥ 0 and ≤ 5. Requires width and/or height to take effect.
>
> **source** `string` *required*
>
> Imgix source domain (e.g., 'my-source'). Do not include 'https\://' or trailing slash.'
>
> **asset\_path** `string` *required*
>
> Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Imgix URL Expiration
>
> **Slug:** `IMGIX_EXPIRES`
>
> Tool 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
>
> **path** `string` *required*
>
> Asset path within the source (e.g., "images/photo.jpg"). Exclude leading slash.
>
> **expires** `integer` *required*
>
> Absolute UNIX timestamp (seconds since epoch) after which the URL will return 404
>
> **source\_domain** `string` *required*
>
> Imgix source domain (e.g., "my-source.imgix.net"). Exclude protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_FIT
>
> **Slug:** `IMGIX_FIT`
>
> Tool to control how an image fits target dimensions after resizing. Use when specifying width, height, and fit behavior.
>
> #### Input Parameters
>
> **h** `string` *required*
>
> Output height in pixels (1-8192) or ratio (0.0-1.0) of source height
>
> **w** `string` *required*
>
> Output width in pixels (1-8192) or ratio (0.0-1.0) of source width
>
> **fit** `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.
>
> **facepad** `number`
>
> Padding around detected faces as fraction of face bounding box when fit='facearea'
>
> **faceindex** `integer`
>
> Select which detected face to prioritize when fit='facearea'
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_FM
>
> **Slug:** `IMGIX_FM`
>
> Tool to choose output file format for the rendered asset. Use after specifying the asset path when you need to convert its format.
>
> #### Input Parameters
>
> **fm** `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.
>
> **path** `string` *required*
>
> Asset path within the source (e.g., "images/photo.jpg")
>
> **source** `string` *required*
>
> Imgix source domain (e.g., "my-source.imgix.net")
>
> **lossless** `boolean`
>
> Only valid when fm='webp' or fm='jxr'. Set to true to request lossless WebP or JPEG XR delivery.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Force Aspect Ratio
>
> **Slug:** `IMGIX_FORCE_ASPECT_RATIO`
>
> Tool 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
>
> **h** `string`
>
> Desired height in pixels (integer) or as a ratio (0.0-1.0). If omitted and 'w' is set, 'h' is auto-calculated.
>
> **w** `string`
>
> Desired width in pixels (integer) or as a ratio (0.0-1.0). If omitted and 'h' is set, 'w' is auto-calculated.
>
> **ar** `string` *required*
>
> Target aspect ratio in 'W:H' format. Use integers or decimals, e.g., '16:9', '4:3', '1.5:1'.
>
> **fit** `string ("crop" | "fill")` *required*
>
> How the image fits the target ratio. Must be 'crop' or 'fill'.
>
> **crop** `string ("top" | "bottom" | "left" | "right" | "faces" | "focalpoint" | "edges" | "entropy")`
>
> When 'fit=crop', controls alignment of the crop box. Defaults to center if unset.
>
> **fill** `string ("solid" | "blur" | "gradient" | "gen")`
>
> When 'fit=fill', determines how excess space is filled. Options: 'solid', 'blur', 'gradient', 'gen'.
>
> **path** `string` *required*
>
> Path to the image on your Imgix source, e.g., 'images/photo.jpg'. Exclude leading slash.
>
> **fill\_color** `string`
>
> Color for solid fill, e.g., '#ff0000' or 'red'. Only used when 'fill=solid'.
>
> **source\_domain** `string` *required*
>
> Your Imgix source domain, e.g., 'my-source.imgix.net'. Exclude protocol ('http\://' or 'https\://').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_GET\_SOURCE
>
> **Slug:** `IMGIX_GET_SOURCE`
>
> Tool to retrieve details for a single imgix Source by its ID. Returns the source configuration including deployment status, type, and settings.
>
> #### Input Parameters
>
> **source\_id** `string` *required*
>
> The unique identifier of the source to retrieve.
>
> **fields\_sources** `string`
>
> Comma-separated list of Source fields to return; use dot notation for nested fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_GET\_UPLOAD\_SESSION\_STATUS
>
> **Slug:** `IMGIX_GET_UPLOAD_SESSION_STATUS`
>
> Tool 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
>
> **source\_id** `string` *required*
>
> The source identifier where the upload session exists.
>
> **session\_id** `string` *required*
>
> The unique identifier for the upload session (UUID format).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_H
>
> **Slug:** `IMGIX_H`
>
> Fetch 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
>
> **h** `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.
>
> **source** `string` *required*
>
> Imgix source domain (e.g., 'my-source'). Do not include protocol or trailing slash.
>
> **asset\_path** `string` *required*
>
> Path to the image on your Imgix source (e.g., 'photos/image.jpg'); omit leading slash.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Adjust Image Highlights
>
> **Slug:** `IMGIX_HIGH`
>
> Tool to adjust highlight tonal mapping (−100 to 0). Use when preserving detail in bright areas of an image.
>
> #### Input Parameters
>
> **high** `number`
>
> Highlight tonal mapping adjustment in percent, between -100 (reduce highlights most) and 0 (no change).
>
> **source** `string` *required*
>
> Imgix source domain (e.g., 'my-source'). Do not include 'https\://' or trailing slash.
>
> **asset\_path** `string` *required*
>
> Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_LIST\_ASSETS
>
> **Slug:** `IMGIX_LIST_ASSETS`
>
> Tool 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
>
> **sort** `string`
>
> Field to sort by. Supported fields: date\_created, date\_modified, file\_size. Prefix with '-' for descending order (e.g., '-date\_created').
>
> **source\_id** `string` *required*
>
> The unique identifier of the source to list assets from.
>
> **page\_limit** `integer`
>
> Number of items per page. Must be ≥ 1.
>
> **filter\_tags** `string`
>
> Comma-separated tag values to filter by (AND logic).
>
> **page\_cursor** `string`
>
> Cursor for pagination. Use the 'next' cursor value from a previous response to retrieve the next page.
>
> **filter\_colors** `string`
>
> Hex color code without the '#' symbol to filter by dominant color.
>
> **filter\_keyword** `string`
>
> Search keyword to filter assets across multiple fields including origin path and description.
>
> **filter\_categories** `string`
>
> Comma-separated category values to filter by (AND logic).
>
> **filter\_face\_count** `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).
>
> **filter\_has\_frames** `boolean`
>
> Filter for animation assets (videos or GIFs). Set to true to return only animations.
>
> **filter\_media\_kind** `string ("IMAGE" | "ANIMATION" | "DOCUMENT" | "VECTOR")`
>
> Filter by asset type.
>
> **filter\_origin\_path** `string`
>
> Filter by asset path relative to source prefix.
>
> **filter\_warning\_racy** `string`
>
> Filter by racy content warning level (0-5 scale). Single integer or range format: '1:3', '1:', ':2'.
>
> **filter\_warning\_adult** `string`
>
> Filter by adult content warning level (0-5 scale). Single integer or range format: '1:3', '1:', ':2'.
>
> **filter\_warning\_spoof** `string`
>
> Filter by spoof content warning level (0-5 scale). Single integer or range format: '1:3', '1:', ':2'.
>
> **filter\_warning\_medical** `string`
>
> Filter by medical content warning level (0-5 scale). Single integer or range format: '1:3', '1:', ':2'.
>
> **filter\_warning\_violence** `string`
>
> Filter by violence content warning level (0-5 scale). Single integer or range format: '1:3', '1:', ':2'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_LIST\_REPORTS
>
> **Slug:** `IMGIX_LIST_REPORTS`
>
> Retrieve a list of available reports for an Imgix account, with optional filters and sorting, for access to analytics and usage information.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sort by field. Supported fields: period\_end, period\_start, report\_key, report\_type. Prefix with '-' for descending order.
>
> **fields\_reports** `string`
>
> Comma-separated list of report fields to return (sparse fieldsets). Use dot notation for nested fields.
>
> **filter\_completed** `boolean`
>
> Filter by completion status. True returns only completed reports, False returns only incomplete reports.
>
> **filter\_report\_type** `string ("cdn_logs" | "image_analytics" | "mild_errors" | "source_analytics")`
>
> Filter by report type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_LIST\_SOURCES
>
> **Slug:** `IMGIX_LIST_SOURCES`
>
> Tool to list all Sources for an account. Use when you need to retrieve and paginate through sources with optional sorting and filtering.
>
> #### Input Parameters
>
> **sort** `string`
>
> Comma-separated fields to sort by; prepend '-' for descending. Supported: date\_deployed, enabled, name.
>
> **page\_size** `integer`
>
> Page size; must be ≥ 1.
>
> **filter\_name** `string`
>
> Filter by Source name (ANDed with other filters).
>
> **page\_number** `integer`
>
> Zero-indexed page number.
>
> **fields\_sources** `string`
>
> Comma-delimited list of Source fields to return; use dot notation for nested fields.
>
> **filter\_enabled** `boolean`
>
> Filter by enabled status.
>
> **filter\_deployment\_type** `string ("azure" | "gcs" | "s3" | "webfolder" | "webproxy" | "s3_compatible")`
>
> Filter by deployment type.
>
> **filter\_deployment\_region** `string`
>
> S3-Compatible region filter.
>
> **filter\_deployment\_s3\_bucket** `string`
>
> S3 bucket name filter.
>
> **filter\_deployment\_gcs\_bucket** `string`
>
> GCS bucket name filter.
>
> **filter\_deployment\_bucket\_name** `string`
>
> S3-Compatible bucket name filter.
>
> **filter\_deployment\_azure\_bucket** `string`
>
> Azure container name filter.
>
> **filter\_deployment\_custom\_domains** `string`
>
> Custom domains filter.
>
> **filter\_deployment\_imgix\_subdomains** `string`
>
> Imgix subdomains filter.
>
> **filter\_deployment\_storage\_provider** `string`
>
> S3-Compatible storage provider filter.
>
> **filter\_deployment\_webfolder\_base\_url** `string`
>
> Web Folder base URL filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Watermark Base URL
>
> **Slug:** `IMGIX_MARK_BASE`
>
> Tool 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
>
> **mark\_base** `string` *required*
>
> Fully qualified base URL to prepend to the watermark image path. Must include scheme, e.g., '[https://cdn.example.com](https://cdn.example.com)'
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Watermark Fit Mode
>
> **Slug:** `IMGIX_MARK_FIT`
>
> Tool 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
>
> **mark\_fit** `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.
>
> **image\_url** `string` *required*
>
> The Imgix URL to which the watermark fit mode will be applied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Imgix Mark Height
>
> **Slug:** `IMGIX_MARK_H`
>
> Tool 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
>
> **mark** `string` *required*
>
> Overlay source URL for the watermark image or text overlay.
>
> **mark-h** `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.
>
> **image\_url** `string` *required*
>
> Existing Imgix URL to which the watermark height parameter will be applied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_MARK\_PAD
>
> **Slug:** `IMGIX_MARK_PAD`
>
> Set 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
>
> **url** `string` *required*
>
> Full URL of the source image (including any existing query parameters).
>
> **mark-pad** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Watermark Width
>
> **Slug:** `IMGIX_MARK_W`
>
> Set watermark width in an Imgix image URL and return the modified URL.
>
> #### Input Parameters
>
> **mark\_w** `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.
>
> **image\_url** `string` *required*
>
> The Imgix URL to which the watermark width will be applied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_MASK
>
> **Slug:** `IMGIX_MASK`
>
> Tool to apply a mask to an image. Use when needing rounded corners, ellipse shapes, or image-based masks.
>
> #### Input Parameters
>
> **mask** `string`
>
> Mask type: 'corners', 'ellipse', or an image URL; URL or comma-separated values must be URL-encoded
>
> **mask64** `string`
>
> Base64-encoded mask; use when encoding URLs or comma-separated values
>
> **mask-bg** `string`
>
> Background color for masked areas; accepts CSS keywords or hex (e.g., 'FF0000' or 'red')
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)
>
> **corner-radius** `string`
>
> Corner radius in pixels; integer or comma-separated list of up to 4 values, used when mask='corners'
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_MAX\_H
>
> **Slug:** `IMGIX_MAX_H`
>
> Constrain 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
>
> **max-h** `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.
>
> **image\_path** `string` *required*
>
> Path to the image file within the source (e.g., 'photos/hero.jpg'). Leading slashes are automatically handled.
>
> **source\_domain** `string` *required*
>
> Imgix source domain hostname without protocol (e.g., 'my-source.imgix.net' or 'assets.imgix.net'). Do NOT include 'https\://'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_MAX\_W
>
> **Slug:** `IMGIX_MAX_W`
>
> Request 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
>
> **max\_w** `integer` *required*
>
> Maximum allowed output width in pixels (works only with fit=crop). Must be between 1 and 8192.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_PALETTE
>
> **Slug:** `IMGIX_PALETTE`
>
> Extract a color palette from an Imgix image in CSS or JSON form for analyzing its dominant colors.
>
> #### Input Parameters
>
> **colors** `integer`
>
> Number of colors to include in the palette (0-16). Default 6.
>
> **prefix** `string`
>
> CSS class prefix when palette='css'. Ignored for JSON.
>
> **palette** `string ("css" | "json")`
>
> Output format: 'json' for structured data, 'css' for stylesheet.
>
> **signature** `string`
>
> URL signature (s=...) if secure URLs are enabled.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'. Omit leading slash.
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'. Do not include protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set CSS Palette Prefix
>
> **Slug:** `IMGIX_PREFIX`
>
> Tool to set class-name prefix for CSS palette output. Use when customizing CSS selectors for color-palette styling.
>
> #### Input Parameters
>
> **colors** `integer`
>
> Number of colors to include in the palette; default is 6; valid range 0–16.
>
> **prefix** `string`
>
> CSS class name prefix to use instead of the default 'image'; ignored when palette='json'.
>
> **palette** `string ("css" | "json")`
>
> Output format: 'css' to receive a CSS stylesheet, 'json' for JSON palette output; prefix is only applied when 'css'.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'examples/pione.jpg'. May include or omit leading slash.
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'assets.imgix.net'. Do not include protocol.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_PURGE\_ASSET
>
> **Slug:** `IMGIX_PURGE_IMGIX_ASSET`
>
> Tool 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
>
> **url** `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](https://your-source.imgix.net/path/to/image.jpg)). After purge, the next request will fetch a fresh version from origin.
>
> **source\_id** `string`
>
> Optional Source ID to scope the purge operation to a specific source.
>
> **sub\_image** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Output Quality
>
> **Slug:** `IMGIX_Q`
>
> Tool to set output quality for lossy formats. Use when adjusting image compression quality for lossy image delivery.
>
> #### Input Parameters
>
> **q** `integer`
>
> Output quality for lossy formats (jpg, pjpg, webp, avif, jxr). Valid range 0-100; default 75.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_RECT
>
> **Slug:** `IMGIX_RECT`
>
> Tool 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
>
> **h** `string` *required*
>
> Height of the rectangle: integer pixels, fraction (0.0-1.0), or 'full' for full image height.
>
> **w** `string` *required*
>
> Width of the rectangle: integer pixels, fraction (0.0-1.0), or 'full' for full image width.
>
> **x** `string` *required*
>
> Horizontal offset for the rectangle origin: integer pixels, fraction (0.0-1.0), or one of 'left','center','right'.
>
> **y** `string` *required*
>
> Vertical offset for the rectangle origin: integer pixels, fraction (0.0-1.0), or one of 'top','middle','bottom'.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash.
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol ('http\://' or 'https\://').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Imgix Rotate
>
> **Slug:** `IMGIX_ROT`
>
> Tool to rotate an image on Imgix. Use when you need to apply a counter-clockwise rotation (0–359°) with optional mode control.
>
> #### Input Parameters
>
> **rot** `integer`
>
> Degrees to rotate the image counter-clockwise. Must be between 0 and 359.
>
> **path** `string` *required*
>
> Asset path within the source (e.g., "images/photo.jpg"). Exclude leading slash.
>
> **source** `string` *required*
>
> Imgix source domain (e.g., "my-source.imgix.net"). Exclude protocol prefix.
>
> **rot-type** `string ("pivot" | "straighten")`
>
> When set, controls rotation mode: 'pivot' shows full image; 'straighten' zooms and crops.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_ROT\_TYPE
>
> **Slug:** `IMGIX_ROT_TYPE`
>
> Set rotation behavior to pivot or straighten on an Imgix image URL that already has a rotation parameter, and return the modified URL.
>
> #### Input Parameters
>
> **rot-type** `string ("pivot" | "straighten")` *required*
>
> Type of rotation behavior: `pivot` displays the entire image without cropping; `straighten` zooms in and crops to straighten an image.
>
> **image\_url** `string` *required*
>
> Full Imgix image URL to which the `rot-type` parameter will be applied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Text Overlay
>
> **Slug:** `IMGIX_TXT`
>
> Tool to render a single-line UTF-8 text overlay on an image. Use when you need simple text captions.
>
> #### Input Parameters
>
> **txt** `string`
>
> Text string to render (UTF-8 supported, including emoji)
>
> **txt64** `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.
>
> **image\_url** `string` *required*
>
> URL of the source image to overlay text onto
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_TXT\_ALIGN
>
> **Slug:** `IMGIX_TXT_ALIGN`
>
> Request an Imgix image with vertical and horizontal text-overlay alignment parameters and return the image as a downloadable file.
>
> #### Input Parameters
>
> **vertical** `string ("top" | "middle" | "bottom")`
>
> Vertical alignment of the text overlay: 'top', 'middle', or 'bottom'
>
> **horizontal** `string ("left" | "center" | "right")`
>
> Horizontal alignment of the text overlay: 'left', 'center', or 'right'
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Text Color
>
> **Slug:** `IMGIX_TXT_COLOR`
>
> Set 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
>
> **image\_url** `string` *required*
>
> Source Imgix URL or source domain with path
>
> **txt\_color** `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'.
>
> **txt\_color64** `string`
>
> URL-safe Base64-encoded color value. Use when color contains special characters. Mutually exclusive with txt\_color.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Text Font
>
> **Slug:** `IMGIX_TXT_FONT`
>
> Request 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
>
> **font** `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').
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)
>
> **use\_base64** `boolean`
>
> If true, the font value will be URL-safe Base64 encoded and sent in the 'txt-font64' parameter instead of 'txt-font'.
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Text Outline Width
>
> **Slug:** `IMGIX_TXT_LINE`
>
> Set the outline width for overlay text in an Imgix image URL, returning the modified URL.
>
> #### Input Parameters
>
> **txt-line** `integer` *required*
>
> Width of the outline to draw around overlay text in pixels. 0 draws no outline (default). Outline is drawn inside text edges.
>
> **image\_url** `string` *required*
>
> Existing Imgix URL to which the text outline width parameter will be applied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Text Outline Color
>
> **Slug:** `IMGIX_TXT_LINE_COLOR`
>
> Apply 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
>
> **color** `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).
>
> **encode** `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.
>
> **image\_url** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_TXT\_SHAD
>
> **Slug:** `IMGIX_TXT_SHAD`
>
> Fetch 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
>
> **strength** `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.
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'examples/photo.jpg'. Leading slash is optional and will be stripped.
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'assets.imgix.net'. Must not include protocol (http\:// or https\://).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_TXT\_SIZE
>
> **Slug:** `IMGIX_TXT_SIZE`
>
> Fetch 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
>
> **size** `integer`
>
> Font size of the overlay text in pixels; must be ≥ 1
>
> **image\_path** `string` *required*
>
> Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash
>
> **source\_domain** `string` *required*
>
> Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] IMGIX\_UPDATE\_SOURCE
>
> **Slug:** `IMGIX_UPDATE_SOURCE`
>
> Update an existing Imgix Source's name, enabled status, or deployment configuration. Deployment changes trigger automatic redeployment.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> JSON:API data object containing the source updates.
>
> **source\_id** `string` *required*
>
> The unique identifier of the source to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
