AssetOptions
Asset Options define the base properties that are shared across all image and video assets.
The majority of options are defined as part of this core set, but a few type-specific definitions are made available distinctly on the ImageOptions and VideoOptions Types.
Properties
| Property | Types | Required | Default | Description | |
|---|---|---|---|---|---|
| angle | - | - | |||
| art | - | - | |||
| aspectRatio | - | - | Crops or resizes the asset to a new aspect ratio. | More Info | |
| assetType | - | image | The type of asset to deliver. | More Info | |
| assistColorblind | - | - | |||
| autoBrightness | - | - | |||
| autoColor | - | - | |||
| autoContrast | - | - | |||
| background | - | - | |||
| blackwhite | - | - | |||
| blur | - | - | |||
| blurFaces | - | - | |||
| blurRegion | - | - | |||
| border | - | - | |||
| brightness | - | - | |||
| brightnessHSB | - | - | |||
| cartoonify | - | - | |||
| color | - | - | |||
| colorize | - | - | |||
| contrast | - | - | |||
| crop | - | limit | |||
| deliveryType | - | upload | Delivery method of the asset. | More Info | |
| distort | - | - | |||
| dpr | - | - | Delivery method of the asset. | More Info | |
| effects | - | - | Array of objects specifying transformations to be applied to asset. | ||
| fillLight | - | - | |||
| flags | - | - | Alters the regular behavior of another transformation or the overall delivery behavior. | More Info | |
| format | - | auto | Converts (if necessary) and delivers an asset in the specified format. | More Info | |
| gamma | - | - | |||
| gradientFade | - | - | |||
| gravity | - | - | Determines which part of an asset to focus on. Note: Default of auto is applied for supported crop modes only. | More Info | |
| grayscale | - | - | |||
| height | - | - | Height of the given asset. | ||
| improve | - | - | |||
| loop | - | - | |||
| multiply | - | - | |||
| namedTransformations | - | - | Named transformations to apply to asset. | More Info | |
| negate | - | - | |||
| oilPaint | - | - | |||
| opacity | - | - | |||
| outline | - | - | |||
| overlay | - | - | Image or text layer that is applied on top of the base image. | More Info | |
| overlays | - | - | Image or text layers that are applied on top of the base image. | More Info | |
| pixelate | - | - | |||
| pixelateFaces | - | - | |||
| pixelateRegion | - | - | |||
| quality | - | auto | Quality of the delivered asset | More Info | |
| radius | - | - | |||
| rawTransformations | - | - | Array of transformation parameters using the Cloudinary URL API to apply to an asset. | More Info | |
| redeye | - | - | |||
| removeBackground | - | - | Removes the background of an image using the Cloudinary AI Background Removal Add-On (Required). | More Info | |
| replaceColor | - | - | |||
| sanitize | - | - | Runs a sanitizer on SVG images. | More Info | |
| saturation | - | - | |||
| screen | - | - | |||
| seoSuffix | - | - | Configures the URL to include an SEO-friendly suffix in the URL | More Info | |
| sepia | - | - | |||
| shadow | - | - | |||
| sharpen | - | - | |||
| shear | - | - | |||
| simulateColorblind | - | - | |||
| src | Yes | - | Cloudinary Public ID or versioned Cloudinary URL (/v1234/) | ||
| strictTransformations | - | - | Gives you the ability to have more control over what transformations are permitted to be used from your Cloudinary account. | More Info | |
| text | - | - | Text to be overlaid on asset. | More Info | |
| tint | - | - | |||
| transformations | - | - | Deprecated: use namedTransformations instead | More Info | |
| trim | - | - | |||
| underlay | - | - | Public ID of image that is applied under the base image. | More Info | |
| underlays | - | - | Image layers that are applied under the base image. | More Info | |
| unsharpMask | - | - | |||
| vectorize | - | - | |||
| version | - | - | Custom version number to apply to asset URL. | More Info | |
| vibrance | - | - | |||
| vignette | - | - | |||
| width | - | - | Width of the given asset. | ||
| zoom | - | - | Controls how close to crop to the detected coordinates when using face-detection, custom-coordinate, or object-specific gravity. | More Info |