NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Imgix

imgix

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

Images & DesignFile Management & StorageWeb del proveedor
Acciones
44
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (44)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Imgix Auto OptimizationIMGIX_AUTOAcción

Tool to apply automatic best-effort image optimizations. Use when you need to compress, enhance, format, or remove redeye via Imgix's auto parameter.

Parámetros de entrada

  • autostring[]Obligatorio

    List of automatic operations to apply. Allowed values: compress, enhance, format, redeye, true

  • pathstringObligatorio

    Asset path within the source (e.g., "images/photo.jpg")

  • sourcestringObligatorio

    Imgix source domain (e.g., "my-source.imgix.net")

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Blend OverlayIMGIX_BLENDAcción

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.

Parámetros de entrada

  • blendstring

    URL-encoded overlay URL (image or text), absolute or relative.

  • blend64string

    URL-safe Base64-encoded overlay URL (image or text).

  • blend_hnumber

    Overlay height in pixels (>1) or ratio of base height (0.0-1.0)

  • blend_wnumber

    Overlay width in pixels (>1) or ratio of base width (0.0-1.0)

  • blend_xinteger

    Horizontal offset in pixels from the left edge

  • blend_yinteger

    Vertical offset in pixels from the top edge

  • blend_fitstringenum

    How the overlay is fit into its blend_w/blend_h box

    clampclipcropmaxscale
  • blend_padinteger

    Padding in pixels around the overlay when alignment is used

  • blend_cropstring

    When blend_fit='crop', crop focus: top, bottom, left, right, faces; CSV

  • blend_modestringenum

    How the overlay interacts with the base image.

    normaldarkenmultiplyburnlightenscreendodgeoverlaysoftlighthardlightdifferenceexclusion+4
  • blend_sizestring

    If 'inherit', overlay inherits base image sizing/cropping

  • blend_alignstring

    Overlay alignment: top, middle, bottom, left, center, right or 'horizontal,vertical'.

  • blend_alphainteger

    Overlay transparency (0 transparent, 100 opaque).

  • blend_colorstring

    Solid color overlay; accepts keywords or hex strings (3/4/6/8-digit AARRGGBB).

  • base_image_urlstringObligatorio

    The URL of the base image to which the overlay will be applied

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Imgix Blend AlignIMGIX_BLEND_ALIGNAcción

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').

Parámetros de entrada

  • verticalstringenum

    Vertical alignment of the overlay relative to the base image

    topmiddlebottom
  • image_urlstringObligatorio

    The Imgix image URL to which the blend-align parameter will be applied

  • horizontalstringenum

    Horizontal alignment of the overlay relative to the base image

    leftcenterright

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Blend Color Over ImageIMGIX_BLEND_COLORAcción

Tool to blend a solid color over an image using CSS keyword or hex. Use when you need to apply color overlay transformations to an existing image URL.

Parámetros de entrada

  • image_urlstringObligatoriouri

    Source image URL

  • blend_modestringenum

    How the color blends with the image; default is 'overlay'

    normaldarkenmultiplyburnlightenscreendodgeoverlaysoftlighthardlightdifferenceexclusion+4
  • blend_alphainteger

    Overlay transparency from 0 (transparent) to 100 (opaque)

  • blend_colorstringObligatorio

    Color keyword or 3-/4-/6-/8-digit hex; for hex, prefix with '#' optional; 4/8-digit include alpha channel

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Imgix Blend X PositionIMGIX_BLEND_XAcción

Tool to position the overlay horizontally on an Imgix-rendered image. Use when you need to offset the blend layer by a specified number of pixels from the left edge.

Parámetros de entrada

  • blendstringObligatorio

    Overlay image URL or color code (e.g., hex code), must enable blending.

  • blend_xinteger

    Horizontal offset in pixels from the left edge. Defaults to 0.

  • image_urlstringObligatoriouri

    Base image URL without existing query parameters.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Draw Image BorderIMGIX_BORDERAcción

Tool to draw a border around an image. Use when you need to overlay a border without resizing.

Parámetros de entrada

  • colorstringObligatorio

    Border color as a CSS keyword or hexadecimal value (3/4/6/8-digit), e.g., 'red', 'FF0000', or '80FF0000'

  • widthintegerObligatorio

    Border thickness in pixels; must be a positive integer.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/pic.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Adjust Image BrightnessIMGIX_BRIAcción

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.

Parámetros de entrada

  • brinumber

    Brightness adjustment in percent, between -100 (darkest) and 100 (brightest). Default is 0 (no change).

  • sourcestringObligatorio

    Imgix source domain (e.g., 'my-source'). Do not include 'https://' or trailing slash.

  • asset_pathstringObligatorio

    Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_CHAcción

Tool to opt in to Client Hints. Use when you want Imgix URLs to adapt based on browser headers (Width, DPR, Save-Data).

Parámetros de entrada

  • chstring[]Obligatorio

    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_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Extract Image Color PaletteIMGIX_COLORSAcción

Tool to specify how many colors to return when extracting a color palette. Use when you need to control palette size and format.

Parámetros de entrada

  • colorsinteger

    Number of colors to include in the palette (0-16). Default 6.

  • prefixstring

    CSS class prefix when palette='css'. Ignored for JSON.

  • palettestringenum

    Output format: 'json' for structured data, 'css' for stylesheet.

    cssjson
  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'. Omit leading slash.

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'. Do not include protocol.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Adjust Image ContrastIMGIX_CONAcción

Tool to adjust image contrast. Use when you need to modify an image's contrast level (−100 to 100).

Parámetros de entrada

  • connumber

    Contrast adjustment in percent, between -100 (lowest contrast) and 100 (highest contrast). Default is 0 for no change.

  • sourcestringObligatorio

    Imgix source domain (e.g., 'my-source'). Do not include 'https://' or trailing slash.

  • asset_pathstringObligatorio

    Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_CROPAcción

Tool to control cropping alignment and behavior using Imgix's 'crop' parameter.

Parámetros de entrada

  • hinteger

    Output height in pixels or as ratio (0.0-1.0).

  • winteger

    Output width in pixels or as ratio (0.0-1.0).

  • arstring

    Optional aspect ratio in 'W:H' format (e.g., '16:9'). Used with fit=crop/fill to maintain ratio.

  • fitstringenum

    How the image fits target dimensions. Commonly 'crop' when using the crop parameter.

    clampclipcropfaceareafillfillmaxmaxminscale
  • cropstringObligatorio

    Crop alignment and strategy. Provide a comma-separated string or a list including any of: top, bottom, left, right, faces, focalpoint, edges, entropy.

  • fp-xnumber

    Focal point X coordinate (0.0-1.0) when crop=focalpoint.

  • fp-ynumber

    Focal point Y coordinate (0.0-1.0) when crop=focalpoint.

  • fp-znumber

    Focal point zoom (typically 1.0-5.0) when crop=focalpoint.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'examples/pione.jpg'. Omit leading slash.

  • source_domainstringObligatorio

    Imgix source domain (hostname only), e.g., 'assets.imgix.net'. Exclude protocol.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_CSAcción

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).

Parámetros de entrada

  • csstringenum

    Color space of the output image. Accepted values: 'origin', 'srgb', 'adobergb1998', 'tinysrgb', 'strip'. If omitted, uses 'origin'.

    originsrgbadobergb1998tinysrgbstrip
  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_DLAcción

Tool to force asset download. Use when you need to download an Imgix asset with a specific filename.

Parámetros de entrada

  • dlstring

    Desired download filename. When provided, forces download with this filename.

  • dl64string

    Base64-encoded (URL-safe) download filename. Mutually exclusive with dl.

  • pathstringObligatorio

    Asset path within the source (e.g., "images/photo.jpg")

  • sourcestringObligatorio

    Imgix source domain (e.g., "my-source.imgix.net")

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Adjust Image DPIIMGIX_DPIAcción

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.

Parámetros de entrada

  • fmstringenum

    Optional. Convert the image to this format before setting DPI (only 'jpg' or 'png').

    jpgpng
  • dpiintegerObligatorio

    Dots per inch (DPI) to embed in the image Exif header; integer ≥1. Only applies to JPEG and PNG images.

  • sourcestringObligatorio

    Imgix source domain without protocol (e.g., 'my-source'). Do not include 'https://' or trailing slash.

  • asset_pathstringObligatorio

    Asset path on your Imgix source (e.g., 'photos/image.jpg'). Do not include leading slash.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Device Pixel RatioIMGIX_DPRAcción

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.

Parámetros de entrada

  • hinteger

    Desired output height in pixels (integer ≥ 1). At least one of width or height is required.'

  • winteger

    Desired output width in pixels (integer ≥ 1). At least one of width or height is required.'

  • dprnumber

    Device pixel ratio controlling image output density. Default is 1; must be ≥ 0 and ≤ 5. Requires width and/or height to take effect.

  • sourcestringObligatorio

    Imgix source domain (e.g., 'my-source'). Do not include 'https://' or trailing slash.'

  • asset_pathstringObligatorio

    Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Imgix URL ExpirationIMGIX_EXPIRESAcción

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.

Parámetros de entrada

  • pathstringObligatorio

    Asset path within the source (e.g., "images/photo.jpg"). Exclude leading slash.

  • expiresintegerObligatorio

    Absolute UNIX timestamp (seconds since epoch) after which the URL will return 404

  • source_domainstringObligatorio

    Imgix source domain (e.g., "my-source.imgix.net"). Exclude protocol.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_FITAcción

Tool to control how an image fits target dimensions after resizing. Use when specifying width, height, and fit behavior.

Parámetros de entrada

  • hintegerObligatorio

    Output height in pixels (1-8192) or ratio (0.0-1.0) of source height

  • wintegerObligatorio

    Output width in pixels (1-8192) or ratio (0.0-1.0) of source width

  • fitstringObligatorioenum

    Specifies how to fit the image within the target dimensions. One of: clamp, clip, crop, facearea, fill, fillmax, max, min, scale.

    clampclipcropfaceareafillfillmaxmaxminscale
  • facepadnumber

    Padding around detected faces as fraction of face bounding box when fit='facearea'

  • faceindexinteger

    Select which detected face to prioritize when fit='facearea'

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_FMAcción

Tool to choose output file format for the rendered asset. Use after specifying the asset path when you need to convert its format.

Parámetros de entrada

  • fmstringObligatorioenum

    Output format to convert the asset to. Valid values: avif, gif, jp2, jpg, json, jxr, pjpg, mp4, png, png8, png32, webm, webp, blurhash.

    avifgifjp2jpgjsonjxrpjpgmp4pngpng8png32webm+2
  • pathstringObligatorio

    Asset path within the source (e.g., "images/photo.jpg")

  • sourcestringObligatorio

    Imgix source domain (e.g., "my-source.imgix.net")

  • losslessboolean

    Only valid when fm='webp'. Set to true to request lossless WebP delivery

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Force Aspect RatioIMGIX_FORCE_ASPECT_RATIOAcción

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.

Parámetros de entrada

  • hinteger

    Desired height in pixels (integer) or as a ratio (0.0-1.0). If omitted and 'w' is set, 'h' is auto-calculated.

  • winteger

    Desired width in pixels (integer) or as a ratio (0.0-1.0). If omitted and 'h' is set, 'w' is auto-calculated.

  • arstringObligatorio

    Target aspect ratio in 'W:H' format. Use integers or decimals, e.g., '16:9', '4:3', '1.5:1'.

  • fitstringObligatorioenum

    How the image fits the target ratio. Must be 'crop' or 'fill'.

    cropfill
  • cropstringenum

    When 'fit=crop', controls alignment of the crop box. Defaults to center if unset.

    topbottomleftrightfacesfocalpointedgesentropy
  • fillstringenum

    When 'fit=fill', determines how excess space is filled. Options: 'solid', 'blur', 'gradient', 'gen'.

    solidblurgradientgen
  • pathstringObligatorio

    Path to the image on your Imgix source, e.g., 'images/photo.jpg'. Exclude leading slash.

  • fill_colorstring

    Color for solid fill, e.g., '#ff0000' or 'red'. Only used when 'fill=solid'.

  • source_domainstringObligatorio

    Your Imgix source domain, e.g., 'my-source.imgix.net'. Exclude protocol ('http://' or 'https://').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_HAcción

Tool to set output image height in pixels or as a ratio of the source height. Use after constructing an Imgix URL to adjust only height.

Parámetros de entrada

  • hintegerObligatorio

    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.

  • sourcestringObligatorio

    Imgix source domain (e.g., 'my-source'). Do not include protocol or trailing slash.

  • asset_pathstringObligatorio

    Path to the image on your Imgix source (e.g., 'photos/image.jpg'); omit leading slash.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Adjust Image HighlightsIMGIX_HIGHAcción

Tool to adjust highlight tonal mapping (−100 to 0). Use when preserving detail in bright areas of an image.

Parámetros de entrada

  • highnumber

    Highlight tonal mapping adjustment in percent, between -100 (reduce highlights most) and 0 (no change).

  • sourcestringObligatorio

    Imgix source domain (e.g., 'my-source'). Do not include 'https://' or trailing slash.

  • asset_pathstringObligatorio

    Path to the image asset on your Imgix source (e.g., 'photos/image.jpg'). No leading slash.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_LIST_SOURCESAcción

Tool to list all Sources for an account. Use when you need to retrieve and paginate through sources with optional sorting and filtering.

Parámetros de entrada

  • sortstring

    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]stringenum

    Filter by deployment type.

    azuregcss3webfolderwebproxys3_compatible
  • 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.

Parámetros de salida

  • dataobject[]Obligatorio
  • metaobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • jsonapiobjectObligatorio
  • includedarray
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Watermark Base URLIMGIX_MARK_BASEAcción

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.

Parámetros de entrada

  • mark_basestringObligatorio

    Fully qualified base URL to prepend to the watermark image path. Must include scheme, e.g., 'https://cdn.example.com'

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Watermark Fit ModeIMGIX_MARK_FITAcción

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.

Parámetros de entrada

  • mark_fitstringenum

    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.

    clipcropmaxscale
  • image_urlstringObligatorio

    The Imgix URL to which the watermark fit mode will be applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Imgix Mark HeightIMGIX_MARK_HAcción

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.

Parámetros de entrada

  • markstringObligatoriouri

    Overlay source URL for the watermark image or text overlay.

  • mark-hintegerObligatorio

    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_urlstringObligatoriouri

    Existing Imgix URL to which the watermark height parameter will be applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_MARK_PADAcción

Tool to set pixel padding between a watermark and the image edge or between tiled watermarks. Use after configuring watermark URL and alignment to adjust spacing precisely.

Parámetros de entrada

  • urlstringObligatorio

    Full URL of the source image (including any existing query parameters).

  • mark-padinteger

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Watermark WidthIMGIX_MARK_WAcción

Tool to set watermark width. Use when you need to enforce a watermark's width in pixels or as a proportion. Use after specifying watermark source.

Parámetros de entrada

  • mark_wintegerObligatorio

    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_urlstringObligatorio

    The Imgix URL to which the watermark width will be applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_MASKAcción

Tool to apply a mask to an image. Use when needing rounded corners, ellipse shapes, or image-based masks.

Parámetros de entrada

  • maskstring

    Mask type: 'corners', 'ellipse', or an image URL; URL or comma-separated values must be URL-encoded

  • mask64string

    Base64-encoded mask; use when encoding URLs or comma-separated values

  • mask-bgstring

    Background color for masked areas; accepts CSS keywords or hex (e.g., 'FF0000' or 'red')

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)

  • corner-radiusinteger

    Corner radius in pixels; integer or comma-separated list of up to 4 values, used when mask='corners'

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_MAX_HAcción

Tool to limit output image height. Use when fit=crop is applied to prevent excessively tall images.

Parámetros de entrada

  • max-hintegerObligatorio

    Maximum allowed output image height in pixels; only enforced when fit=crop is used

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_MAX_WAcción

Tool to set the maximum output width on an Imgix URL. Use when you need to cap width (works only with fit=crop). Call after specifying fit=crop on the URL.

Parámetros de entrada

  • max_wintegerObligatorio

    Maximum allowed output width in pixels (works only with fit=crop). Must be between 1 and 8192.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_PALETTEAcción

Tool to extract a color palette from an image in CSS or JSON form. Use when you need to analyze an image's dominant colors after any transformations.

Parámetros de entrada

  • colorsinteger

    Number of colors to include in the palette (0-16). Default 6.

  • prefixstring

    CSS class prefix when palette='css'. Ignored for JSON.

  • palettestringenum

    Output format: 'json' for structured data, 'css' for stylesheet.

    cssjson
  • signaturestring

    URL signature (s=...) if secure URLs are enabled.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'. Omit leading slash.

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'. Do not include protocol.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set CSS Palette PrefixIMGIX_PREFIXAcción

Tool to set class-name prefix for CSS palette output. Use when customizing CSS selectors for color-palette styling.

Parámetros de entrada

  • colorsinteger

    Number of colors to include in the palette; default is 6; valid range 0–16.

  • prefixstring

    CSS class name prefix to use instead of the default 'image'; ignored when palette='json'.

  • palettestringenum

    Output format: 'css' to receive a CSS stylesheet, 'json' for JSON palette output; prefix is only applied when 'css'.

    cssjson
  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'examples/pione.jpg'. May include or omit leading slash.

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'assets.imgix.net'. Do not include protocol.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Output QualityIMGIX_QAcción

Tool to set output quality for lossy formats. Use when adjusting image compression quality for lossy image delivery.

Parámetros de entrada

  • qinteger

    Output quality for lossy formats (jpg, pjpg, webp, avif, jxr). Valid range 0-100; default 75.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_RECTAcción

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.

Parámetros de entrada

  • hintegerObligatorio

    Height of the rectangle: integer pixels, fraction (0.0-1.0), or 'full' for full image height.

  • wintegerObligatorio

    Width of the rectangle: integer pixels, fraction (0.0-1.0), or 'full' for full image width.

  • xintegerObligatorio

    Horizontal offset for the rectangle origin: integer pixels, fraction (0.0-1.0), or one of 'left','center','right'.

  • yintegerObligatorio

    Vertical offset for the rectangle origin: integer pixels, fraction (0.0-1.0), or one of 'top','middle','bottom'.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash.

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol ('http://' or 'https://').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Imgix RotateIMGIX_ROTAcción

Tool to rotate an image on Imgix. Use when you need to apply a counter-clockwise rotation (0–359°) with optional mode control.

Parámetros de entrada

  • rotinteger

    Degrees to rotate the image counter-clockwise. Must be between 0 and 359.

  • pathstringObligatorio

    Asset path within the source (e.g., "images/photo.jpg"). Exclude leading slash.

  • sourcestringObligatorio

    Imgix source domain (e.g., "my-source.imgix.net"). Exclude protocol prefix.

  • rot-typestringenum

    When set, controls rotation mode: 'pivot' shows full image; 'straighten' zooms and crops.

    pivotstraighten

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_ROT_TYPEAcción

Tool to control rotation behavior when `rot` is applied. Use after applying a `rot` parameter to choose between pivot (show entire image) or straighten (zoom and crop) behavior.

Parámetros de entrada

  • rot-typestringObligatorioenum

    Type of rotation behavior: `pivot` displays the entire image without cropping; `straighten` zooms in and crops to straighten an image.

    pivotstraighten
  • image_urlstringObligatoriouri

    Full Imgix image URL to which the `rot-type` parameter will be applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Text OverlayIMGIX_TXTAcción

Tool to render a single-line UTF-8 text overlay on an image. Use when you need simple text captions.

Parámetros de entrada

  • txtstring

    Text string to render (UTF-8 supported, including emoji)

  • txt64string

    URL-safe Base64 variant of the text (omit '=' padding)

  • image_urlstringObligatorio

    URL of the source image to overlay text onto

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_TXT_ALIGNAcción

Tool to align a text overlay on an Imgix image. Use when you need to position text by specifying vertical (top/middle/bottom) and horizontal (left/center/right) alignment.

Parámetros de entrada

  • verticalstringenum

    Vertical alignment of the text overlay: 'top', 'middle', or 'bottom'

    topmiddlebottom
  • horizontalstringenum

    Horizontal alignment of the text overlay: 'left', 'center', or 'right'

    leftcenterright
  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Text ColorIMGIX_TXT_COLORAcción

Tool to set text overlay color on an Imgix image. Use when customizing text overlays with CSS color keywords or hex codes.

Parámetros de entrada

  • image_urlstringObligatoriouri

    Source Imgix URL or source domain with path

  • txt_colorstring

    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_color64string

    URL-safe Base64-encoded color value. Use when color contains special characters. Mutually exclusive with txt_color.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Text FontIMGIX_TXT_FONTAcción

Tool to choose font family/style for overlay text. Use when customizing text appearance after specifying content. Supports CSS font categories and optional bold/italic flags.

Parámetros de entrada

  • fontstringObligatorio

    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_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)

  • use_base64boolean

    If true, the font value will be URL-safe Base64 encoded and sent in the 'txt-font64' parameter instead of 'txt-font'.

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Text Outline WidthIMGIX_TXT_LINEAcción

Tool to set outline width around overlay text. Use when styling text overlays on images.

Parámetros de entrada

  • txt-lineintegerObligatorio

    Width of the outline to draw around overlay text in pixels. 0 draws no outline (default). Outline is drawn inside text edges.

  • image_urlstringObligatoriouri

    Existing Imgix URL to which the text outline width parameter will be applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Text Outline ColorIMGIX_TXT_LINE_COLORAcción

Tool to set outline color for text. Use after enabling txt-line on an Imgix URL.

Parámetros de entrada

  • colorstringObligatorio

    Text outline color when 'txt-line' is enabled. Accepts CSS keywords or 3- (RGB), 4- (ARGB), 6- (RRGGBB), or 8-digit (AARRGGBB) hex codes.

  • encodeboolean

    If true, use Base64 encoding and send as 'txt-line-color64'

  • image_urlstringObligatoriouri

    Imgix image URL with txt-line parameter set

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_TXT_SHADAcción

Tool to set text shadow strength for overlay text. Use when you need to apply a drop shadow to text.

Parámetros de entrada

  • strengthinteger

    Strength of text shadow (0–10). If not provided, no shadow is applied.

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg' (omit leading slash)

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net' (exclude protocol)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

IMGIX_TXT_SIZEAcción

Tool to set text font size in pixels. Use when overlaying text and needing precise control over font size. Specify after defining the text content; default is 12px.

Parámetros de entrada

  • sizeinteger

    Font size of the overlay text in pixels; must be ≥ 1

  • image_pathstringObligatorio

    Path to the image within the source, e.g., 'images/photo.jpg'; omit leading slash

  • source_domainstringObligatorio

    Imgix source domain (hostname), e.g., 'example-source.imgix.net'; exclude protocol

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not