Image Helper

Categories: Helpers

Type: imageHelper/v1

Actions

Compress Image

Name: compressImage

Compress image with specified quality.

Properties

Name	Label	Type	Description	Required
image	Image	FILE_ENTRY	The image file to process.	true
quality	Quality	NUMBER	Compression quality of the image.	true
resultFileName	Result File Name	STRING	Specifies the output file name for the result image.	true

Example JSON Structure

{
  "label" : "Compress Image",
  "name" : "compressImage",
  "parameters" : {
    "image" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "quality" : 0.0,
    "resultFileName" : ""
  },
  "type" : "imageHelper/v1/compressImage"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Crop Image

Name: cropImage

Crops an image to the specified dimensions.

Properties

Name	Label	Type	Description	Required
image	Image	FILE_ENTRY	The image file to process.	true
x	X Coordinate	INTEGER	The horizontal starting point of the crop area.	true
y	Y Coordinate	INTEGER	The vertical starting point of the crop area.	true
width	Width	INTEGER	Width of the crop area.	true
height	Height	INTEGER	Height of the crop area.	true
resultFileName	Result File Name	STRING	Specifies the output file name for the result image.	true

Example JSON Structure

{
  "label" : "Crop Image",
  "name" : "cropImage",
  "parameters" : {
    "image" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "x" : 1,
    "y" : 1,
    "width" : 1,
    "height" : 1,
    "resultFileName" : ""
  },
  "type" : "imageHelper/v1/cropImage"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Get Image Metadata

Name: getImageMetadata

Get metadata of the image.

Properties

Name	Label	Type	Description	Required
image	Image	FILE_ENTRY	The image file to process.	true
resultFileName	Result File Name	STRING	Specifies the output file name for the result image.	true

Example JSON Structure

{
  "label" : "Get Image Metadata",
  "name" : "getImageMetadata",
  "parameters" : {
    "image" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "resultFileName" : ""
  },
  "type" : "imageHelper/v1/getImageMetadata"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Image to Base64

Name: imageToBase64

Converts image to Base64 string.

Properties

Name	Label	Type	Description	Required
image	Image	FILE_ENTRY	The image file to process.	true

Example JSON Structure

{
  "label" : "Image to Base64",
  "name" : "imageToBase64",
  "parameters" : {
    "image" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    }
  },
  "type" : "imageHelper/v1/imageToBase64"
}

Output

Type: STRING

Resize Image

Name: resizeImage

Resizes an image to the specified width and height.

Properties

Name	Label	Type	Description	Required
image	Image	FILE_ENTRY	The image file to process.	true
width	Width	INTEGER	The target width of the image in pixels.	true
height	Height	INTEGER	The target height of the image in pixels.	true
resultFileName	Result File Name	STRING	Specifies the output file name for the result image.	true

Example JSON Structure

{
  "label" : "Resize Image",
  "name" : "resizeImage",
  "parameters" : {
    "image" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "width" : 1,
    "height" : 1,
    "resultFileName" : ""
  },
  "type" : "imageHelper/v1/resizeImage"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

Rotate Image

Name: rotateImage

Rotates an image by a specified degree.

Properties

Name	Label	Type	Description	Required
image	Image	FILE_ENTRY	The image file to process.	true
degree	Degree	INTEGER Options 90, 180, 270	Specifies the degree of clockwise rotation applied to the image.	true
resultFileName	Result File Name	STRING	Specifies the output file name for the result image.	true

Example JSON Structure

{
  "label" : "Rotate Image",
  "name" : "rotateImage",
  "parameters" : {
    "image" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "degree" : 1,
    "resultFileName" : ""
  },
  "type" : "imageHelper/v1/rotateImage"
}

Output

Type: FILE_ENTRY

Properties

Name	Type	Description
extension	STRING
mimeType	STRING
name	STRING
url	STRING

Output Example

{
  "extension" : "",
  "mimeType" : "",
  "name" : "",
  "url" : ""
}

On this page