---
title: "Dummy test endpoint using all shared models"
method: POST
path: "/v1/dummy/test"
tags: ["Dummy Test"]
---

# Dummy test endpoint using all shared models

`POST /v1/dummy/test`

Internal test endpoint for SDK generation purposes only. This endpoint demonstrates usage of all shared models defined in the Stainless configuration and is not intended for public consumption.

## Request body

- object
  - `extensions` union[] — Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type.
    - union
      - RemovedotBGExtension
        - `name` 'remove-bg', required — Specifies the background removal extension.
        - `options` object
          - `add_shadow` boolean — Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos.
          - `semitransparency` boolean — Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows.
          - `bg_color` string — Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty.
          - `bg_image_url` string — Sets a background image from a URL. If this parameter is set, `bg_color` must be empty.
      - AutoTaggingExtension
        - `name` 'google-auto-tagging' | 'aws-auto-tagging', required — Specifies the auto-tagging extension used.
        - `minConfidence` integer, required — Minimum confidence level for tags to be considered valid.
        - `maxTags` integer, required — Maximum number of tags to attach to the asset.
      - AutoDescriptionExtension
        - `name` 'ai-auto-description', required — Specifies the auto description extension.
      - AITasksExtension
        - `name` 'ai-tasks', required — Specifies the AI tasks extension for automated image analysis using AI models.
        - `tasks` union[], required — Array of task objects defining AI operations to perform on the asset.
          - union
            - AITaskSelectTags
              - …
            - AITaskSelectMetadata
              - …
            - AITaskYesNo
              - …
      - SavedExtensionReference
        - `name` 'saved-extension', required — Indicates this is a reference to a saved extension.
        - `id` string, required — The unique ID of the saved extension to apply.
  - `savedExtensions` SavedExtension — Saved extension object containing extension configuration.
    - `id` string — Unique identifier of the saved extension.
    - `name` string — Name of the saved extension.
    - `description` string — Description of the saved extension.
    - `config` union — Configuration object for an extension (base extensions only, not saved extension references).
      - object
        - `name` 'remove-bg', required — Specifies the background removal extension.
        - `options` object
          - `add_shadow` boolean — Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos.
          - `semitransparency` boolean — Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows.
          - `bg_color` string — Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty.
          - `bg_image_url` string — Sets a background image from a URL. If this parameter is set, `bg_color` must be empty.
      - object
        - `name` 'google-auto-tagging' | 'aws-auto-tagging', required — Specifies the auto-tagging extension used.
        - `minConfidence` integer, required — Minimum confidence level for tags to be considered valid.
        - `maxTags` integer, required — Maximum number of tags to attach to the asset.
      - object
        - `name` 'ai-auto-description', required — Specifies the auto description extension.
      - object
        - `name` 'ai-tasks', required — Specifies the AI tasks extension for automated image analysis using AI models.
        - `tasks` union[], required — Array of task objects defining AI operations to perform on the asset.
          - union
            - AITaskSelectTags
              - …
            - AITaskSelectMetadata
              - …
            - AITaskYesNo
              - …
    - `createdAt` string, date-time — Timestamp when the saved extension was created.
    - `updatedAt` string, date-time — Timestamp when the saved extension was last updated.
  - `extensionConfig` union — Configuration object for an extension (base extensions only, not saved extension references).
    - object
      - `name` 'remove-bg', required — Specifies the background removal extension.
      - `options` object
        - `add_shadow` boolean — Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos.
        - `semitransparency` boolean — Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows.
        - `bg_color` string — Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty.
        - `bg_image_url` string — Sets a background image from a URL. If this parameter is set, `bg_color` must be empty.
    - object
      - `name` 'google-auto-tagging' | 'aws-auto-tagging', required — Specifies the auto-tagging extension used.
      - `minConfidence` integer, required — Minimum confidence level for tags to be considered valid.
      - `maxTags` integer, required — Maximum number of tags to attach to the asset.
    - object
      - `name` 'ai-auto-description', required — Specifies the auto description extension.
    - object
      - `name` 'ai-tasks', required — Specifies the AI tasks extension for automated image analysis using AI models.
      - `tasks` union[], required — Array of task objects defining AI operations to perform on the asset.
        - union
          - AITaskSelectTags
            - `type` 'select_tags', required — Task type that analyzes the image and adds matching tags from a vocabulary.
            - `instruction` string, required — The question or instruction for the AI to analyze the image.
            - `vocabulary` string[] — Array of possible tag values. The combined length of all strings must not exceed 500 characters, and values cannot include the `%` character. When providing large vocabularies (more than 30 items), the AI may not follow the list strictly.
            - `min_selections` integer — Minimum number of tags to select from the vocabulary.
            - `max_selections` integer — Maximum number of tags to select from the vocabulary.
          - AITaskSelectMetadata
            - `type` 'select_metadata', required — Task type that analyzes the image and sets a custom metadata field value from a vocabulary.
            - `instruction` string, required — The question or instruction for the AI to analyze the image.
            - `field` string, required — Name of the custom metadata field to set. The field must exist in your account.
            - `vocabulary` union[] — An array of possible values matching the custom metadata field type. If not provided for SingleSelect or MultiSelect field types, all values from the custom metadata field definition will be used. When providing large vocabularies (above 30 items), the AI may not strictly adhere to the list.
              - …
            - `min_selections` integer — Minimum number of values to select from the vocabulary.
            - `max_selections` integer — Maximum number of values to select from the vocabulary.
          - AITaskYesNo
            - `type` 'yes_no', required — Task type that asks a yes/no question and executes actions based on the answer.
            - `instruction` string, required — The yes/no question for the AI to answer about the image.
            - `on_yes` AITaskAction — Defines actions to perform based on AI task results.
              - …
            - `on_no` AITaskAction — Defines actions to perform based on AI task results.
              - …
            - `on_unknown` AITaskAction — Defines actions to perform based on AI task results.
              - …
  - `srcOptions` SrcOptions — Options for generating ImageKit URLs with transformations. See the [Transformations guide](https://imagekit.io/docs/transformations).
    - `src` string, required — Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`. If an absolute path is provided, `urlEndpoint` is ignored.
    - `urlEndpoint` string, uri, required — Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints).
    - `transformation` Transformation[] — An array of objects specifying the transformations to be applied in the URL. If more than one transformation is specified, they are applied in the order they are specified as chained transformations. See [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations).
      - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
        - number
        - string
      - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
        - number
        - string
      - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
        - number
        - string
      - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
      - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
      - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
      - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
      - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
      - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
      - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
      - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
      - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
        - number
        - 'max'
        - string
      - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
        - number
        - string
      - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
      - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
      - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
      - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
      - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
      - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
        - number
        - string
      - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
        - number
        - string
      - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
      - `grayscale` unknown
      - `aiUpscale` unknown
      - `aiRetouch` unknown
      - `aiVariation` unknown
      - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
        - unknown
        - string
      - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
      - `aiRemoveBackground` unknown
      - `aiRemoveBackgroundExternal` unknown
      - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
      - `contrastStretch` unknown
      - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
        - unknown
        - string
      - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
        - unknown
        - number
      - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
        - unknown
        - string
      - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
        - unknown
        - string
      - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
      - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
      - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
      - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
      - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
      - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
        - unknown
        - number
      - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
      - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
        - number
        - string
      - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
      - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
      - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
      - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
      - `overlay` union — Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers).
        - TextOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'text', required
          - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
          - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
          - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
            - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
              - …
            - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
            - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
            - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
              - …
            - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
            - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
            - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
            - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
              - …
            - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
            - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
              - …
        - ImageOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'image', required
          - `input` string, required — Specifies the relative path to the image used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` Transformation[] — Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
        - VideoOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'video', required
          - `input` string, required — Specifies the relative path to the video used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` Transformation[] — Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. See [Video transformations](https://imagekit.io/docs/video-transformation).
        - SubtitleOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'subtitle', required
          - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
            - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
            - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - SolidColorOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'solidColor', required
          - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
          - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
            - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
            - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
              - …
    - `queryParameters` object — These are additional query parameters that you want to add to the final URL. They can be any query parameters and not necessarily related to ImageKit. This is especially useful if you want to add a versioning parameter to your URLs.
    - `transformationPosition` 'path' | 'query' — By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`. If you want to add the transformation string in the path of the URL, set this to `path`. Learn more in the [Transformations guide](https://imagekit.io/docs/transformations).
    - `signed` boolean — Whether to sign the URL or not. Set this to `true` if you want to generate a signed URL. If `signed` is `true` and `expiresIn` is not specified, the signed URL will not expire (valid indefinitely). Note: If `expiresIn` is set to any value above 0, the URL will always be signed regardless of this setting. [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls).
    - `expiresIn` number — When you want the signed URL to expire, specified in seconds. If `expiresIn` is anything above 0, the URL will always be signed even if `signed` is set to false. If not specified and `signed` is `true`, the signed URL will not expire (valid indefinitely). Example: Setting `expiresIn: 3600` will make the URL expire 1 hour from generation time. After the expiry time, the signed URL will no longer be valid and ImageKit will return a 401 Unauthorized status code. [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls).
  - `getImageAttributesOptions` GetImageAttributesOptions — Options for generating ImageKit URLs with transformations. See the [Transformations guide](https://imagekit.io/docs/transformations).
    - `src` string, required — Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`. If an absolute path is provided, `urlEndpoint` is ignored.
    - `urlEndpoint` string, uri, required — Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints).
    - `transformation` Transformation[] — An array of objects specifying the transformations to be applied in the URL. If more than one transformation is specified, they are applied in the order they are specified as chained transformations. See [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations).
      - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
        - number
        - string
      - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
        - number
        - string
      - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
        - number
        - string
      - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
      - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
      - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
      - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
      - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
      - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
      - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
      - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
      - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
        - number
        - 'max'
        - string
      - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
        - number
        - string
      - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
      - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
      - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
      - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
      - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
      - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
        - number
        - string
      - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
        - number
        - string
      - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
      - `grayscale` unknown
      - `aiUpscale` unknown
      - `aiRetouch` unknown
      - `aiVariation` unknown
      - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
        - unknown
        - string
      - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
      - `aiRemoveBackground` unknown
      - `aiRemoveBackgroundExternal` unknown
      - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
      - `contrastStretch` unknown
      - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
        - unknown
        - string
      - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
        - unknown
        - number
      - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
        - unknown
        - string
      - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
        - unknown
        - string
      - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
      - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
      - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
      - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
      - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
      - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
        - unknown
        - number
      - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
      - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
        - number
        - string
      - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
      - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
      - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
      - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
      - `overlay` union — Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers).
        - TextOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'text', required
          - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
          - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
          - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
            - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
              - …
            - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
            - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
            - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
              - …
            - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
            - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
            - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
            - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
              - …
            - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
            - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
              - …
        - ImageOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'image', required
          - `input` string, required — Specifies the relative path to the image used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` Transformation[] — Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
        - VideoOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'video', required
          - `input` string, required — Specifies the relative path to the video used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` Transformation[] — Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. See [Video transformations](https://imagekit.io/docs/video-transformation).
        - SubtitleOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'subtitle', required
          - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
            - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
            - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - SolidColorOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'solidColor', required
          - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
          - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
            - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
            - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
              - …
    - `queryParameters` object — These are additional query parameters that you want to add to the final URL. They can be any query parameters and not necessarily related to ImageKit. This is especially useful if you want to add a versioning parameter to your URLs.
    - `transformationPosition` 'path' | 'query' — By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`. If you want to add the transformation string in the path of the URL, set this to `path`. Learn more in the [Transformations guide](https://imagekit.io/docs/transformations).
    - `signed` boolean — Whether to sign the URL or not. Set this to `true` if you want to generate a signed URL. If `signed` is `true` and `expiresIn` is not specified, the signed URL will not expire (valid indefinitely). Note: If `expiresIn` is set to any value above 0, the URL will always be signed regardless of this setting. [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls).
    - `expiresIn` number — When you want the signed URL to expire, specified in seconds. If `expiresIn` is anything above 0, the URL will always be signed even if `signed` is set to false. If not specified and `signed` is `true`, the signed URL will not expire (valid indefinitely). Example: Setting `expiresIn: 3600` will make the URL expire 1 hour from generation time. After the expiry time, the signed URL will no longer be valid and ImageKit will return a 401 Unauthorized status code. [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls).
    - `width` number — The intended display width of the image in pixels, used **only when the `sizes` attribute is not provided**. Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors in `srcSet`. Ignored if `sizes` is present.
    - `sizes` string — The value for the HTML `sizes` attribute (e.g., `"100vw"` or `"(min-width:768px) 50vw, 100vw"`). - If it includes one or more `vw` units, breakpoints smaller than the corresponding percentage of the smallest device width are excluded. - If it contains no `vw` units, the full breakpoint list is used. Enables a width-based strategy and generates `w` descriptors in `srcSet`.
    - `deviceBreakpoints` number[] — Custom list of **device-width breakpoints** in pixels. These define common screen widths for responsive image generation. Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`. Sorted automatically.
    - `imageBreakpoints` number[] — Custom list of **image-specific breakpoints** in pixels. Useful for generating small variants (e.g., placeholders or thumbnails). Merged with `deviceBreakpoints` before calculating `srcSet`. Defaults to `[16, 32, 48, 64, 96, 128, 256, 384]`. Sorted automatically.
  - `responsiveImageAttributes` ResponsiveImageAttributes — Resulting set of attributes suitable for an HTML `<img>` element. Useful for enabling responsive image loading with `srcSet` and `sizes`.
    - `src` string, uri, required — URL for the *largest* candidate (assigned to plain `src`).
    - `srcSet` string — Candidate set with `w` or `x` descriptors. Multiple image URLs separated by commas, each with a descriptor.
    - `sizes` string — `sizes` returned (or synthesised as `100vw`). The value for the HTML `sizes` attribute.
    - `width` number — Width as a number (if `width` was provided in the input options).
  - `transformation` Transformation — The SDK provides easy-to-use names for transformations. These names are converted to the corresponding transformation string before being added to the URL. SDKs are updated regularly to support new transformations. If you want to use a transformation that is not supported by the SDK, You can use the `raw` parameter to pass the transformation string directly. See the [Transformations documentation](https://imagekit.io/docs/transformations).
    - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
      - number
      - string
    - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
      - number
      - string
    - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
      - number
      - string
    - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
    - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
    - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
    - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
    - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
    - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
    - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
    - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
      - number
      - string
    - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
      - number
      - string
    - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
      - number
      - string
    - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
      - number
      - string
    - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
    - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
    - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
    - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
      - number
      - 'max'
      - string
    - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
      - number
      - string
    - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
    - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
    - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
    - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
    - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
    - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
      - number
      - string
    - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
      - number
      - string
    - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
      - number
      - string
    - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
    - `grayscale` unknown
    - `aiUpscale` unknown
    - `aiRetouch` unknown
    - `aiVariation` unknown
    - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
      - unknown
      - string
    - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
    - `aiRemoveBackground` unknown
    - `aiRemoveBackgroundExternal` unknown
    - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
    - `contrastStretch` unknown
    - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
      - unknown
      - string
    - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
      - unknown
      - number
    - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
      - unknown
      - string
    - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
      - unknown
      - string
    - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
    - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
    - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
    - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
    - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
    - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
      - unknown
      - number
    - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
    - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
      - number
      - string
    - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
    - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
    - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
    - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
    - `overlay` union — Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers).
      - TextOverlay
        - `position` OverlayPosition
          - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
          - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
        - `timing` OverlayTiming
          - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
            - number
            - string
          - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
            - number
            - string
          - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
            - number
            - string
        - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
        - `type` 'text', required
        - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
        - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
        - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
          - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
            - number
            - string
          - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
          - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
          - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
          - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
            - number
            - string
          - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
          - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
          - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
          - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
            - number
            - 'max'
            - string
          - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
            - number
            - string
          - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
          - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
            - number
            - string
      - ImageOverlay
        - `position` OverlayPosition
          - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
          - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
        - `timing` OverlayTiming
          - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
            - number
            - string
          - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
            - number
            - string
          - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
            - number
            - string
        - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
        - `type` 'image', required
        - `input` string, required — Specifies the relative path to the image used as an overlay.
        - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
        - `transformation` Transformation[] — Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
      - VideoOverlay
        - `position` OverlayPosition
          - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
          - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
        - `timing` OverlayTiming
          - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
            - number
            - string
          - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
            - number
            - string
          - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
            - number
            - string
        - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
        - `type` 'video', required
        - `input` string, required — Specifies the relative path to the video used as an overlay.
        - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
        - `transformation` Transformation[] — Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. See [Video transformations](https://imagekit.io/docs/video-transformation).
      - SubtitleOverlay
        - `position` OverlayPosition
          - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
          - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
        - `timing` OverlayTiming
          - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
            - number
            - string
          - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
            - number
            - string
          - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
            - number
            - string
        - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
        - `type` 'subtitle', required
        - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
        - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
        - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
          - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
          - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
          - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
          - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
          - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
          - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
          - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
      - SolidColorOverlay
        - `position` OverlayPosition
          - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
          - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
        - `timing` OverlayTiming
          - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
            - number
            - string
          - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
            - number
            - string
          - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
            - number
            - string
        - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
        - `type` 'solidColor', required
        - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
        - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
          - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
            - number
            - string
          - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
            - number
            - 'max'
            - string
          - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
          - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
          - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
            - unknown
            - string
  - `transformationPosition` 'path' | 'query' — By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`. If you want to add the transformation string in the path of the URL, set this to `path`. Learn more in the [Transformations guide](https://imagekit.io/docs/transformations).
  - `streamingResolution` '240' | '360' | '480' | '720' | '1080' | '1440' | '2160' — Available streaming resolutions for [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming)
  - `overlay` union — Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers).
    - TextOverlay
      - `position` OverlayPosition
        - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
        - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
      - `timing` OverlayTiming
        - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
          - number
          - string
        - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
          - number
          - string
      - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
      - `type` 'text', required
      - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
      - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
      - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
        - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
          - number
          - string
        - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
        - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
        - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
        - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
          - number
          - string
        - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
        - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
        - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
        - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
          - number
          - 'max'
          - string
        - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
          - number
          - string
        - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
        - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
          - number
          - string
    - ImageOverlay
      - `position` OverlayPosition
        - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
        - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
      - `timing` OverlayTiming
        - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
          - number
          - string
        - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
          - number
          - string
      - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
      - `type` 'image', required
      - `input` string, required — Specifies the relative path to the image used as an overlay.
      - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
      - `transformation` Transformation[] — Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
        - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
          - number
          - string
        - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
          - number
          - string
        - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
          - number
          - string
        - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
        - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
        - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
        - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
        - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
        - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
        - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
        - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
        - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
        - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
        - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
          - number
          - 'max'
          - string
        - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
          - number
          - string
        - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
        - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
        - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
        - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
        - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
        - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
          - number
          - string
        - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
          - number
          - string
        - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
        - `grayscale` unknown
        - `aiUpscale` unknown
        - `aiRetouch` unknown
        - `aiVariation` unknown
        - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
          - unknown
          - string
        - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
        - `aiRemoveBackground` unknown
        - `aiRemoveBackgroundExternal` unknown
        - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
        - `contrastStretch` unknown
        - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
          - unknown
          - string
        - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
          - unknown
          - number
        - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
          - unknown
          - string
        - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
          - unknown
          - string
        - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
        - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
        - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
        - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
        - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
        - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
          - unknown
          - number
        - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
        - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
          - number
          - string
        - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
        - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
        - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
        - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
        - `overlay` Overlay — recursive
    - VideoOverlay
      - `position` OverlayPosition
        - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
        - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
      - `timing` OverlayTiming
        - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
          - number
          - string
        - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
          - number
          - string
      - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
      - `type` 'video', required
      - `input` string, required — Specifies the relative path to the video used as an overlay.
      - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
      - `transformation` Transformation[] — Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. See [Video transformations](https://imagekit.io/docs/video-transformation).
        - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
          - number
          - string
        - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
          - number
          - string
        - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
          - number
          - string
        - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
        - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
        - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
        - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
        - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
        - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
        - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
        - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
          - number
          - string
        - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
        - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
        - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
        - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
          - number
          - 'max'
          - string
        - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
          - number
          - string
        - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
        - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
        - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
        - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
        - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
        - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
          - number
          - string
        - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
          - number
          - string
        - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
        - `grayscale` unknown
        - `aiUpscale` unknown
        - `aiRetouch` unknown
        - `aiVariation` unknown
        - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
          - unknown
          - string
        - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
        - `aiRemoveBackground` unknown
        - `aiRemoveBackgroundExternal` unknown
        - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
        - `contrastStretch` unknown
        - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
          - unknown
          - string
        - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
          - unknown
          - number
        - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
          - unknown
          - string
        - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
          - unknown
          - string
        - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
        - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
        - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
        - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
        - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
        - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
          - unknown
          - number
        - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
        - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
          - number
          - string
        - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
        - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
        - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
        - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
        - `overlay` Overlay — recursive
    - SubtitleOverlay
      - `position` OverlayPosition
        - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
        - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
      - `timing` OverlayTiming
        - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
          - number
          - string
        - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
          - number
          - string
      - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
      - `type` 'subtitle', required
      - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
      - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
      - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
        - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
        - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
    - SolidColorOverlay
      - `position` OverlayPosition
        - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
        - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
      - `timing` OverlayTiming
        - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
          - number
          - string
        - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
          - number
          - string
        - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
          - number
          - string
      - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
      - `type` 'solidColor', required
      - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
      - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
        - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
          - number
          - string
        - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
          - number
          - 'max'
          - string
        - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
        - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
        - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
          - unknown
          - string
  - `baseOverlay` BaseOverlay
    - `position` OverlayPosition
      - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
      - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
    - `timing` OverlayTiming
      - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
        - number
        - string
      - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
        - number
        - string
    - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
  - `overlayPosition` OverlayPosition
    - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
      - number
      - string
    - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
      - number
      - string
    - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
      - number
      - string
    - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
      - number
      - string
    - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
    - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
  - `overlayTiming` OverlayTiming
    - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
      - number
      - string
    - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
      - number
      - string
    - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
      - number
      - string
  - `textOverlay` TextOverlay
    - `position` OverlayPosition
      - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
      - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
    - `timing` OverlayTiming
      - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
        - number
        - string
      - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
        - number
        - string
    - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
    - `type` 'text', required
    - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
    - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
    - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
      - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
        - number
        - string
      - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
      - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
      - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
      - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
        - number
        - string
      - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
      - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
      - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
      - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
        - number
        - 'max'
        - string
      - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
        - number
        - string
      - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
      - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
        - number
        - string
  - `imageOverlay` ImageOverlay
    - `position` OverlayPosition
      - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
      - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
    - `timing` OverlayTiming
      - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
        - number
        - string
      - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
        - number
        - string
    - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
    - `type` 'image', required
    - `input` string, required — Specifies the relative path to the image used as an overlay.
    - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
    - `transformation` Transformation[] — Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
      - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
        - number
        - string
      - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
        - number
        - string
      - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
        - number
        - string
      - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
      - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
      - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
      - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
      - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
      - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
      - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
      - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
      - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
        - number
        - 'max'
        - string
      - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
        - number
        - string
      - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
      - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
      - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
      - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
      - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
      - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
        - number
        - string
      - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
        - number
        - string
      - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
      - `grayscale` unknown
      - `aiUpscale` unknown
      - `aiRetouch` unknown
      - `aiVariation` unknown
      - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
        - unknown
        - string
      - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
      - `aiRemoveBackground` unknown
      - `aiRemoveBackgroundExternal` unknown
      - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
      - `contrastStretch` unknown
      - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
        - unknown
        - string
      - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
        - unknown
        - number
      - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
        - unknown
        - string
      - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
        - unknown
        - string
      - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
      - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
      - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
      - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
      - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
      - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
        - unknown
        - number
      - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
      - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
        - number
        - string
      - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
      - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
      - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
      - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
      - `overlay` union — Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers).
        - TextOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'text', required
          - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
          - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
          - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
            - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
              - …
            - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
            - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
            - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
              - …
            - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
            - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
            - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
            - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
              - …
            - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
            - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
              - …
        - ImageOverlay — recursive
        - VideoOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'video', required
          - `input` string, required — Specifies the relative path to the video used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` Transformation[] — Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. See [Video transformations](https://imagekit.io/docs/video-transformation).
        - SubtitleOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'subtitle', required
          - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
            - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
            - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - SolidColorOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'solidColor', required
          - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
          - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
            - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
            - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
              - …
  - `videoOverlay` VideoOverlay
    - `position` OverlayPosition
      - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
      - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
    - `timing` OverlayTiming
      - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
        - number
        - string
      - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
        - number
        - string
    - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
    - `type` 'video', required
    - `input` string, required — Specifies the relative path to the video used as an overlay.
    - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
    - `transformation` Transformation[] — Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. See [Video transformations](https://imagekit.io/docs/video-transformation).
      - `width` union — Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). You can also supply arithmetic expressions (e.g., `iw_div_2`). Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w)
        - number
        - string
      - `height` union — Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h)
        - number
        - string
      - `aspectRatio` union — Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar).
        - number
        - string
      - `background` string — Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). - Dominant color: `dominant` extracts the dominant color from the image. See [Dominant color background](https://imagekit.io/docs/effects-and-enhancements#dominant-color-background). - Gradient: `gradient_dominant` or `gradient_dominant_2` creates a gradient using the dominant colors. Optionally specify palette size (2 or 4), e.g., `gradient_dominant_4`. See [Gradient background](https://imagekit.io/docs/effects-and-enhancements#gradient-background). - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill).
      - `border` string — Adds a border to the output media. Accepts a string in the format `<border-width>_<hex-code>` (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b).
      - `crop` 'force' | 'at_max' | 'at_max_enlarge' | 'at_least' | 'maintain_ratio' | 'maintain_ratio_no_enlarge' — Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `cropMode` 'pad_resize' | 'extract' | 'pad_extract' | 'pad_resize_no_enlarge' | 'pad_extract_no_shrink' — Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus).
      - `dpr` number — Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. Also accepts arithmetic expressions. - Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). - See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr).
      - `focus` string — Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— while resizing. - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name)
      - `quality` number — Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. See [Quality](https://imagekit.io/docs/image-optimization#quality---q).
      - `x` union — Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `xCenter` union — Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `y` union — Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `yCenter` union — Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates).
        - number
        - string
      - `format` 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig' — Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. You can also pass `orig` for images to return the original format. ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f).
      - `videoCodec` 'h264' | 'vp9' | 'av1' | 'none' — Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc).
      - `audioCodec` 'aac' | 'opus' | 'none' — Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac).
      - `radius` union — Specifies the corner radius for rounded corners. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
        - number
        - 'max'
        - string
      - `rotation` union — Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation or `auto` to use the orientation specified in the image's EXIF data. For videos, only the following values are supported: 0, 90, 180, 270, or 360. See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt).
        - number
        - string
      - `blur` number — Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl).
      - `named` string — Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations).
      - `defaultImage` string — Specifies a fallback image if the resource is not found, e.g., a URL or file path. See [Default image](https://imagekit.io/docs/image-transformation#default-image---di).
      - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flips or mirrors an image either horizontally, vertically, or both. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl).
      - `original` boolean — If set to true, serves the original file without applying any transformations. See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true).
      - `startOffset` union — Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Arithmetic expressions are also supported. See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so).
        - number
        - string
      - `endOffset` union — Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to define a time window. Arithmetic expressions are supported. See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo).
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du).
        - number
        - string
      - `streamingResolutions` StreamingResolution[] — An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming).
      - `grayscale` unknown
      - `aiUpscale` unknown
      - `aiRetouch` unknown
      - `aiVariation` unknown
      - `aiDropShadow` union — Adds an AI-based drop shadow around a foreground object on a transparent or removed background. Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. Supported inside overlay. See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow).
        - unknown
        - string
      - `aiChangeBackground` string — Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg).
      - `aiRemoveBackground` unknown
      - `aiRemoveBackgroundExternal` unknown
      - `aiEdit` string — Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. Not supported inside overlay. See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit).
      - `contrastStretch` unknown
      - `shadow` union — Adds a shadow beneath solid objects in an image with a transparent background. For AI-based drop shadows, refer to aiDropShadow. Pass `true` for a default shadow, or provide a string for a custom shadow. See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow).
        - unknown
        - string
      - `sharpen` union — Sharpens the input image, highlighting edges and finer details. Pass `true` for default sharpening, or provide a numeric value for custom sharpening. See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen).
        - unknown
        - number
      - `unsharpMask` union — Applies Unsharp Masking (USM), an image sharpening technique. Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm).
        - unknown
        - string
      - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
        - unknown
        - string
      - `progressive` boolean — Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, pixelated version of the full image, which gradually improves to provide a faster perceived load time. See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr).
      - `lossless` boolean — Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo).
      - `colorProfile` boolean — Indicates whether the output image should retain the original color profile. See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp).
      - `metadata` boolean — By default, ImageKit removes all metadata during automatic image compression. Set this to true to preserve metadata. See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md).
      - `opacity` number — Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o).
      - `trim` union — Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, leaving only the central object in the output image. See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t).
        - unknown
        - number
      - `zoom` number — Accepts a numeric value that determines how much to zoom in or out of the cropped area. It should be used in conjunction with fo-face or fo-<object_name>. See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z).
      - `page` union — Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), or by name (e.g., `name-layer-4` for a PSD layer). See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files).
        - number
        - string
      - `colorReplace` string — Replaces colors in the image. Supports three formats: - `toColor` - Replace dominant color with the specified color. - `toColor_tolerance` - Replace dominant color with specified tolerance (0-100). - `toColor_tolerance_fromColor` - Replace a specific color with another within tolerance range. Colors can be hex codes (e.g., `FF0022`) or names (e.g., `red`, `blue`). See [Color replacement](https://imagekit.io/docs/effects-and-enhancements#color-replace---cr).
      - `colorize` string — Applies a color tint to the image. Accepts color and intensity as optional parameters. - `co-color` - Color to apply (e.g., `red`, `blue`, `FF0022`). Default is gray color. - `in-intensity` - Intensity of the color (0-100). Default is 100. See [Colorize](https://imagekit.io/docs/effects-and-enhancements#colorize---e-colorize).
      - `distort` string — Distorts the shape of an image. Supports two modes: - Perspective distortion: `p-x1_y1_x2_y2_x3_y3_x4_y4` changes the position of the four corners starting clockwise from top-left. - Arc distortion: `a-degrees` curves the image upwards (positive values) or downwards (negative values). See [Distort effect](https://imagekit.io/docs/effects-and-enhancements#distort---e-distort).
      - `raw` string — Pass any transformation not directly supported by the SDK. This transformation string is appended to the URL as provided.
      - `overlay` union — Specifies an overlay to be applied on the parent image or video. ImageKit supports overlays including images, text, videos, subtitles, and solid colors. See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers).
        - TextOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'text', required
          - `text` string, required — Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding.
          - `encoding` 'auto' | 'plain' | 'base64' — Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). By default, the SDK selects the appropriate format based on the input text. To always use base64 (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method, the input text is always percent-encoded to ensure it is URL-safe.
          - `transformation` TextOverlayTransformation[] — Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay).
            - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
              - …
            - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
            - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
            - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
              - …
            - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
            - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
            - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
            - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `rotation` union — Specifies the rotation angle of the text overlay. Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
              - …
            - `flip` 'h' | 'v' | 'h_v' | 'v_h' — Flip/mirror the text horizontally, vertically, or in both directions. Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
            - `lineHeight` union — Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines. Accepts either an integer value or an arithmetic expression.
              - …
        - ImageOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'image', required
          - `input` string, required — Specifies the relative path to the image used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` Transformation[] — Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay).
        - VideoOverlay — recursive
        - SubtitleOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'subtitle', required
          - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
          - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
          - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
            - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
            - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
            - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
        - SolidColorOverlay
          - `position` OverlayPosition
            - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
            - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
          - `timing` OverlayTiming
            - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
              - …
            - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
              - …
            - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
              - …
          - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
          - `type` 'solidColor', required
          - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
          - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
            - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
              - …
            - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
              - …
            - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
            - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
            - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
              - …
  - `subtitleOverlay` SubtitleOverlay
    - `position` OverlayPosition
      - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
      - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
    - `timing` OverlayTiming
      - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
        - number
        - string
      - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
        - number
        - string
    - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
    - `type` 'subtitle', required
    - `input` string, required — Specifies the relative path to the subtitle file used as an overlay.
    - `encoding` 'auto' | 'plain' | 'base64' — The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. By default, the SDK determines the appropriate format automatically. To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. To always use plain text (`i-{input}`), set it to `plain`. Regardless of the encoding method: - Leading and trailing slashes are removed. - Remaining slashes within the path are replaced with `@@` when using plain text.
    - `transformation` SubtitleOverlayTransformation[] — Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer).
      - `background` string — Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
      - `fontSize` number — Sets the font size of subtitle text. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
      - `fontFamily` string — Sets the font family of subtitle text. Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
      - `color` string — Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
      - `typography` 'b' | 'i' | 'b_i' — Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
      - `fontOutline` string — Sets the font outline of the subtitle text. Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
      - `fontShadow` string — Sets the font shadow for the subtitle text. Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer)
  - `solidColorOverlay` SolidColorOverlay
    - `position` OverlayPosition
      - `x` union — Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lx` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `y` union — Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `xCenter` union — Specifies the x-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can be used with `y`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `yCenter` union — Specifies the y-coordinate on the base asset where the overlay's center will be positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can be used with `x`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `anchorPoint` 'top' | 'left' | 'right' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | 'center' — Sets the anchor point on the base asset from which the overlay offset is calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
      - `focus` 'center' | 'top' | 'left' | 'bottom' | 'right' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' — Specifies the position of the overlay relative to the parent image or video. If one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this parameter is ignored. Maps to `lfo` in the URL.
    - `timing` OverlayTiming
      - `start` union — Specifies the start time (in seconds) for when the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `lso` in the URL.
        - number
        - string
      - `duration` union — Specifies the duration (in seconds) during which the overlay should appear on the base video. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `ldu` in the URL.
        - number
        - string
      - `end` union — Specifies the end time (in seconds) for when the overlay should disappear from the base video. If both end and duration are provided, duration is ignored. Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. Applies only if the base asset is a video. Maps to `leo` in the URL.
        - number
        - string
    - `layerMode` 'multiply' | 'cutter' | 'cutout' | 'displace' — Controls how the layer blends with the base image or underlying content. Maps to `lm` in the URL. By default, layers completely cover the base image beneath them. Layer modes change this behavior: - `multiply`: Multiplies the pixel values of the layer with the base image. The result is always darker than the original images. This is ideal for applying shadows or color tints. - `displace`: Uses the layer as a displacement map to distort pixels in the base image. The red channel controls horizontal displacement, and the green channel controls vertical displacement. Requires `x` or `y` parameter to control displacement magnitude. - `cutout`: Acts as an inverse mask where opaque areas of the layer turn the base image transparent, while transparent areas leave the base image unchanged. This mode functions like a hole-punch, effectively cutting the shape of the layer out of the underlying image. - `cutter`: Acts as a shape mask where only the parts of the base image that fall inside the opaque area of the layer are preserved. This mode functions like a cookie-cutter, trimming the base image to match the specific dimensions and shape of the layer. See [Layer modes](https://imagekit.io/docs/add-overlays-on-images#layer-modes).
    - `type` 'solidColor', required
    - `color` string, required — Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99).
    - `transformation` SolidColorOverlayTransformation[] — Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay).
      - `width` union — Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `height` union — Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
        - number
        - string
      - `radius` union — Specifies the corner radius of the solid color overlay. - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
        - number
        - 'max'
        - string
      - `alpha` number — Specifies the transparency level of the overlaid solid color layer. Supports integers from `1` to `9`.
      - `background` string — Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
      - `gradient` union — Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient).
        - unknown
        - string
  - `textOverlayTransformation` TextOverlayTransformation
    - `width` union — Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
      - number
      - string
    - `fontSize` union — Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression.
      - number
      - string
    - `fontFamily` string — Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
    - `fontColor` string — Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
    - `innerAlignment` 'left' | 'right' | 'center' — Specifies the inner alignment of the text when width is more than the text length.
    - `padding` union — Specifies the padding around the overlaid text. Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). Arithmetic expressions are also accepted.
      - number
      - string
    - `alpha` number — Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
    - `typography` string — Specifies the typography style of the text. Supported values: - Single styles: `b` (bold), `i` (italic), `strikethrough`. - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`.
    - `background` string — Specifies the background color of the text overlay. Accepts an RGB hex code, an RGBA code, or a color name.
    - `radius` union — Specifies the corner radius: - Single value (positive integer): Applied to all corners (e.g., `20`). - `max`: Creates a circular or oval shape. - Per-corner array: Provide four underscore-separated values representing top-left, top-right, bottom-right, and bottom-left corners respectively (e.g., `10_20_30_40`). See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r).
- … truncated; see the full OpenAPI document linked below

## Response `204`

No content - Request processed successfully with empty response

## Other responses

- `400` — Bad request
- `401` — Unauthorized request.
- `403` — Forbidden.

---

[API](https://skmtc.dev/imagekit-developer/apis/imagekit-api.md) · [All operations](https://skmtc.dev/imagekit-developer/apis/imagekit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/imagekit-developer/imagekit-api/revisions/bb3e9ff84b3e/schema)