# Encodian

Encodian provides a suite of document management and automation tools, including Flowr, Filer, and Indxr, designed to enhance productivity and streamline workflows within Microsoft 365 environments.

- **Category:** documents
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 69
- **Triggers:** 0
- **Slug:** `ENCODIAN`
- **Version:** 20260312_00

## Tools

### Add Attachments to PDF

**Slug:** `ENCODIAN_ADD_ATTACHMENTS_TO_PDF`

Tool to add file attachments to a PDF document. Use when you need to embed files within a PDF as attachments that can be extracted later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FilePath` | string | No | Absolute path to a local PDF file strictly within the repository. |
| `FileContent` | object | No | The source PDF file to which attachments will be added. |
| `attachments` | array | Yes | Array of files to be attached to the PDF. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, takes precedence over FileContent/FilePath. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Image Watermark to PDF

**Slug:** `ENCODIAN_ADD_IMAGE_WATERMARK`

Tool to add an image watermark to a PDF document. Use when you need to overlay an image on PDF pages with configurable opacity and orientation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Opacity` | number | No | The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7 |
| `FileName` | string | Yes | The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file' |
| `alignImage` | boolean | No | Assure that the image provided is aligned to the EXIF orientation tags |
| `Orientation` | string ("Vertical" | "Horizontal" | "Diagonal") | No | Orientation of the watermark image. |
| `fileContent` | object | No | The PDF file to watermark. |
| `operationId` | string | No | Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID |
| `watermarkId` | integer | No | Override and manually set an identifier for the applied watermark |
| `skipFirstPage` | boolean | No | Set whether to skip applying the watermark to the first page. |
| `FinalOperation` | boolean | No | Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID |
| `fileContentBase64` | string | No | Base64-encoded PDF content. If provided, this will be used instead of fileContent. |
| `watermarkFilename` | string | Yes | The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file' |
| `watermarkFileContent` | object | No | The watermark image file to apply. |
| `watermarkFileContentBase64` | string | No | Base64-encoded watermark image content. If provided, this will be used instead of watermarkFileContent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Image Watermark to PDF (Advanced)

**Slug:** `ENCODIAN_ADD_IMAGE_WATERMARK_ADVANCED`

Tool to add an advanced image watermark to a PDF with precise control over positioning, opacity, scale, quality, and rotation. Use when you need to overlay a watermark image onto PDF pages with page-level targeting and advanced customization options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scale` | number | No | Set the multiple to either reduce (less than 1.0) or increase the size of the image (greater than 1.0), for example: 1.2 is equal to 120%, and 0.7 is equal to 70%. |
| `applyTo` | string ("FirstPage" | "AllPages" | "LastPage" | "Specific") | No | Page selection options for watermark application. |
| `opacity` | number | No | The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7 |
| `quality` | integer | No | Set the quality of the image watermark from 1 to 100. |
| `FileName` | string | Yes | The filename of the source PDF file, the file extension is mandatory: 'file.pdf' and not 'file'. |
| `FilePath` | string | No | Absolute path to a local PDF file. If provided, this will be used instead of FileContent. |
| `alignImage` | boolean | No | Assure that the image provided is aligned to the EXIF orientation tags. |
| `FileContent` | object | No | The PDF file to watermark. |
| `operationId` | string | No | Advanced - Set the identifier of a previous Encodian operation, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID |
| `pageNumbers` | array | No | Specify the page numbers where the watermark should be applied, this only applies when the 'Apply To' property is set to 'Specific'. |
| `watermarkId` | integer | No | Override and manually set an identifier for the applied watermark. |
| `imageXOffset` | number | No | Set the X offset for positioning the watermark image on the page. |
| `imageYOffSet` | number | No | Set the Y offset for positioning the watermark image on the page. |
| `rotationAngle` | number | No | Set the rotation angle of the image watermark in degrees. |
| `skipFirstPage` | boolean | No | Set whether to skip applying the watermark to the first page. |
| `FinalOperation` | boolean | No | Advanced - Return the processed file (File Contents) as opposed to just an Operation ID, please review before using - https://support.encodian.com/hc/en-gb/articles/360010509573-Flow-Action-Return-Options-File-Content-vs-Operation-ID |
| `addToBackground` | boolean | No | If set to 'true' the watermark image will be added to the background of the page. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, this will be used instead of FileContent/FilePath. |
| `WatermarkFilePath` | string | No | Absolute path to a local watermark image file. If provided, this will be used instead of WatermarkFileContent. |
| `ignorePageNumbers` | array | No | Specify the page numbers where the watermark should not applied, this property only applies when the 'Apply To' property is set to 'Specific'. |
| `watermarkFilename` | string | Yes | The filename for the watermark image file, the file extension is mandatory: 'file.jpg' and not 'file'. |
| `WatermarkFileContent` | object | No | The watermark image file. |
| `WatermarkFileContentBase64` | string | No | Base64-encoded watermark image content. If provided, this will be used instead of WatermarkFileContent/WatermarkFilePath. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Array Add Items

**Slug:** `ENCODIAN_ADD_ITEMS_TO_ARRAY`

Tool to add items to a JSON array at a specified position (first, last, or specific index). Use when you need to append or insert elements into an existing JSON array structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | The JSON array or object to modify. Provide as a JSON string. |
| `path` | string | No | Select a specific node within the 'Data' using a JSONPath expression. |
| `items` | string | Yes | The items to add to the 'Data' provided. Provide as a JSON string. |
| `itemIndex` | integer | No | Index of where to add the items. This is only applicable when the 'Item Position' property is set to 'Specific'. |
| `itemPosition` | string ("First" | "Last" | "Specific") | No | Set whether to add items at the first position, last position, or a specific index. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create ZIP Archive

**Slug:** `ENCODIAN_ADD_TO_ZIP`

Tool to create a ZIP archive from multiple documents. Use when you need to compress and package multiple files into a single ZIP file, with optional password protection and folder structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Password` | string | No | Optional password to protect and encrypt the ZIP archive. |
| `encoding` | string ("UTF8" | "UTF7" | "UTF32" | "ASCII" | "Unicode" | "BigEndianUnicode") | No | Encoding type options for the ZIP archive. |
| `documents` | array | Yes | Array of documents to be added to the ZIP archive. Each document must have fileContent (base64) and fileName. |
| `encryption` | string ("ZipCrypto" | "AES128" | "AES256") | No | Encryption level options for password-protected ZIP archives. |
| `FinalOperation` | boolean | No | Return the processed file content as opposed to just an Operation ID. Set to false for async processing. See: https://support.encodian.com/hc/en-gb/articles/360010509573 |
| `outputFilename` | string | Yes | The filename of the output ZIP archive (including .zip extension). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Apply AI OCR to PDF

**Slug:** `ENCODIAN_APPLY_AI_OCR_PDF_DOCUMENT`

Tool to apply AI-powered OCR to a PDF document with optional preprocessing filters. Use when you need to extract text from scanned PDFs or images by recognizing and converting visual text into machine-readable format. Supports advanced preprocessing like deskew, despeckle, binarization, and automatic rotation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Deskew` | boolean | No | Detect the skew angle and rotate to remove that skew. |
| `Rotate` | boolean | No | Automatically detect orientation and rotate so that text is upright. |
| `Binarize` | boolean | No | Convert the document to black and white by computing optimal parameters through analysis. Tuned for dark text on bright background, robust to shadows and noise. |
| `FilePath` | string | No | Absolute path to a local PDF file (strictly within the repository). |
| `Despeckle` | boolean | No | Automatically detect and remove speckles from the document. |
| `FileContent` | object | No | The PDF file to process with AI OCR. |
| `RemoveBorder` | boolean | No | Locate and remove border pixels from the document. |
| `AverageFilter` | boolean | No | Perform a 3x3 Average filter smoothing operation on the document. |
| `SmoothObjects` | boolean | No | Fill in isolated bumps and pits on the edges of pixel groups. Works only on bitonal documents. |
| `ImageDetergent` | boolean | No | Smooth the image by changing pixels of similar color values to a central color value. |
| `RemoveHolePunch` | boolean | No | Detect and remove hole punch marks from a bitonal document. |
| `RemoveDotShading` | boolean | No | Remove shaded regions from bitonal documents. |
| `SmoothBackground` | boolean | No | Smooth background colors to eliminate or de-emphasize noise. Works only on color and grayscale documents. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, this will be used instead of FileContent/FilePath. |
| `RotateConfidenceLevel` | integer | Yes | Minimum confidence percentage (0 to 100) used to control whether rotation is applied. Default is 60. |
| `AdjustBrightnessContrast` | boolean | No | Automatically adjust brightness and contrast based on document analysis. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Apply OCR to PDF (Standard)

**Slug:** `ENCODIAN_APPLY_OCR_PDF_DOCUMENT`

Tool to apply standard OCR to a PDF document with optional preprocessing filters. Use when you need to extract text from scanned PDFs or images by recognizing and converting visual text into machine-readable format. Supports language selection, quality vs speed trade-off, and preprocessing options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Deskew` | boolean | No | Detects the skew angle and rotates to remove that skew. |
| `ocrType` | string ("Quality" | "Fast") | No | OCR processing types supported by Encodian. |
| `Binarize` | boolean | No | Computes all necessary parameters by analyzing the input data before actually performing the binarization. The algorithm is tuned to typical document images, consisting of dark text on brighter background. It is robust to shadows, noise and background images. |
| `FileName` | string | Yes | The filename of the source PDF file. The file extension is mandatory (e.g., 'file.pdf' not 'file'). |
| `FilePath` | string | No | Absolute path to a local PDF file (strictly within the repository). |
| `Despeckle` | boolean | No | Automatically detects speckles and removes them. |
| `AutoRotate` | boolean | No | Automatically detects orientation and rotates it so that the text on it is upright oriented. |
| `FileContent` | object | No | The PDF file to process with OCR. |
| `cleanUpType` | string ("Default" | "None" | "Specific") | No | Document cleanup operation types. |
| `ocrLanguage` | string ("Albanian" | "Arabic" | "Azerbaijani" | "Basque" | "Belarusian" | "Bengali" | "Bosnian" | "Bulgarian" | "Burmese" | "Catalan" | "ChineseSimplified" | "ChineseTraditional" | "Croatian" | "Czech" | "Danish" | "Dutch" | "English" | "Estonian" | "Finnish" | "French" | "Georgian" | "German" | "Greek" | "Gujarati" | "Hebrew" | "Hindi" | "Hungarian" | "Icelandic" | "Indonesian" | "Italian" | "Japanese" | "Kannada" | "Kazakh" | "Khmer" | "Korean" | "Kurdish" | "Kyrgyz" | "Laotian" | "Latin" | "Latvian" | "Lithuanian" | "Macedonian" | "Maharashtra" | "Malay" | "Malayalam" | "Maltese" | "Nepali" | "Norwegian" | "Oriya" | "Panjabi" | "Persian" | "Polish" | "Portuguese" | "Pushto" | "Romanian" | "Russian" | "Sanskrit" | "Serbian" | "Singhalese" | "Slovakian" | "Slovenian" | "Spanish" | "Swahili" | "Swedish" | "Syriac" | "Tamil" | "Telugu" | "Thai" | "Turkish" | "Ukrainian" | "Urdu" | "Uzbek" | "Vietnamese" | "Welsh" | "Yiddish") | No | Languages supported by Encodian OCR. |
| `operationId` | string | No | Advanced - Set the identifier of a previous Encodian operation for operation chaining. |
| `RemoveBorder` | boolean | No | Locates border pixels and removes the pixels from the document, this is disabled by default. |
| `SmoothObjects` | boolean | No | This only works on bitonal documents, it looks at groups of pixels, and finds isolated bumps and pits in the edges of those objects, and fills them in. |
| `FinalOperation` | boolean | No | Advanced - Return the processed file (File Contents) as opposed to just an Operation ID. Set to true to receive file content in response. |
| `ImageDetergent` | boolean | No | Image Detergent works by changing pixels of similar color values to a central color value, which has the result of smoothing the image wherever regions of those colors appear. |
| `pdfaCompliance` | boolean | No | Set PDF/A Compliance option. If true, the output will comply with the specified PDF/A standard. |
| `RemoveHolePunch` | boolean | No | Detects and removes hole punch marks from a bitonal document. |
| `RemoveBlankPages` | boolean | No | Set whether blank pages should be removed from the PDF document. |
| `RemoveDotShading` | boolean | No | This action will remove shaded regions from bitonal documents. |
| `SmoothBackground` | boolean | No | This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, this will be used instead of FileContent/FilePath. |
| `ApplyAverageFilter` | boolean | No | Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window. |
| `pdfaComplianceLevel` | string ("PDF_A_1A" | "PDF_A_1B" | "PDF_A_2A" | "PDF_A_3A" | "PDF_A_2B" | "PDF_A_2U" | "PDF_A_3B" | "PDF_A_3U" | "v_1_3" | "v_1_4" | "v_1_5" | "v_1_6" | "v_1_7" | "PDF_X_1A" | "PDF_X_3") | No | PDF/A compliance levels supported by Encodian. |
| `AdjustBrightnessContrast` | boolean | No | This action analyzes a document and automatically adjusts brightness and contrast based on the analysis. |
| `AutoRotateConfidenceLevel` | integer | Yes | Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied. The default value is 60. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Decode Base64 String

**Slug:** `ENCODIAN_BASE64_DECODE`

Tool to decode a Base64 string to a file. Use when you need to extract binary content (e.g., PDF, image) from Base64 data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileName` | string | Yes | Desired output filename including extension (e.g., 'output.pdf'). |
| `Base64String` | string | Yes | The Base64-encoded content to decode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Base64 Encode

**Slug:** `ENCODIAN_BASE64_ENCODE`

Tool to encode a string to Base64. Use when you need to convert text into Base64 representation for use in other operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | The string to encode to Base64. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Date

**Slug:** `ENCODIAN_CALCULATE_DATE`

Tool to calculate a date by adding or subtracting a time interval from a given date. Use when you need to compute a future or past date based on a starting date and time offset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | The date value to calculate. Provide in ISO format (YYYY-MM-DD) or other standard date formats. |
| `interval` | integer | Yes | The amount of time to add or subtract from the date value provided. |
| `operation` | string ("Add" | "Subtract") | Yes | The operation type: Add to add time to the date, or Subtract to remove time from the date. |
| `cultureName` | string | No | Change the thread culture used to process the request (e.g., 'en-US', 'fr-FR'). |
| `measurement` | string ("Ticks" | "Milliseconds" | "Seconds" | "Minutes" | "Hours" | "Days" | "Months" | "Years") | Yes | The time measurement unit used for the calculation. |
| `daysToExclude` | string | No | Days of the week to be excluded from the calculation as a comma-delimited list (e.g., 'Saturday,Sunday'). |
| `datesToExclude` | string | No | Dates to be excluded from the calculation as a comma-delimited list (e.g., '25/12/2024,26/12/2024'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Array Contains Value

**Slug:** `ENCODIAN_CHECK_ARRAY_CONTAINS_VALUE`

Tool to check if a value exists within a JSON array. Use when you need to verify if a specific value is present in an array, with optional case-insensitive matching and JSONPath support for nested data structures.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | The JSON data to evaluate (JSON array as string). |
| `path` | string | No | Select a specific node within the 'Data' using a JSONPath expression. |
| `value` | string | Yes | The value to check is contained within the array. |
| `ignoreCase` | boolean | No | Set whether text case should be ignored when searching the array. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Text Contains Value

**Slug:** `ENCODIAN_CHECK_TEXT_CONTAINS_VALUE`

Tool to check if a text string contains a specific value with configurable comparison rules. Use when you need to validate whether text contains a substring with options for case sensitivity and culture-specific comparison.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text to validate |
| `value` | string | Yes | The value to check is contained within the 'text' value |
| `ignoreCase` | boolean | No | Set whether text case should be ignored when validating the 'text' value |
| `cultureName` | string | No | Change the thread culture used to process the request |
| `comparisonConfiguration` | string ("CurrentCulture" | "InvariantCulture" | "Ordinal") | No | Specifies the rules to be used when processing the text values provided |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clean String

**Slug:** `ENCODIAN_CLEAN_STRING`

Tool to clean text by removing control characters, invalid filename characters, and custom character sets. Use when you need to sanitize or clean text strings for safe usage in filenames or other contexts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text value to process |
| `trimResult` | boolean | No | Set whether white-space should be trimmed from the processed text value |
| `removeCharacterSet` | string | No | Set the collection of characters to remove from the text value provided |
| `removeControlChars` | boolean | No | Set whether to remove control characters from the text value |
| `removeInvalidFileNameChars` | boolean | No | Set whether to remove characters that are invalid in file names from the text value |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clean Up Photo Image

**Slug:** `ENCODIAN_CLEAN_UP_IMAGE_PHOTO`

Tool to clean up photo images by removing artifacts, correcting orientation, and enhancing quality. Use when you need to improve image quality through operations like auto-rotation, deskewing, despeckling, and color balancing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Blur` | boolean | No | Blurs the current image by averaging each pixel with its neighboring pixels giving an 'out of focus' appearance. |
| `Deskew` | boolean | No | Detects the skew angle and rotates to remove that skew. Enabled by default. |
| `Diffuse` | boolean | No | Diffuses the current image by replacing each pixel with a randomly selected neighboring pixel. |
| `Binarize` | boolean | No | Computes all necessary parameters by analyzing the input data before performing binarization. Tuned for document images with dark text on brighter background. Disabled by default. |
| `Contrast` | boolean | No | Adjusts the contrast in the current image. |
| `FileName` | string | Yes | The filename of the source image file, the file extension is mandatory: 'file.png' and not 'file'. |
| `FilePath` | string | No | Absolute path to a local image file. If provided, this will be used instead of FileContent. |
| `Despeckle` | boolean | No | Automatically detects speckles and removes them. Enabled by default. |
| `AutoRotate` | boolean | No | Automatically detects orientation and rotates so that the text is upright oriented. Enabled by default. |
| `FileContent` | object | No | The source image file to clean up. |
| `cleanUpType` | string ("Default" | "None" | "Specific") | No | Perform file clean-up operations. 'Default' will auto rotate, apply colour balance, auto deskew and auto despeckle. 'None' applies no cleanup. 'Specific' allows individual control of cleanup operations. |
| `ColorBalance` | boolean | No | Restores and balances the color quality within an image. Enabled by default. |
| `RemoveBorder` | boolean | No | Locates border pixels and removes them from the document. Disabled by default. |
| `RemoveRedeye` | boolean | No | Automatically reduces the red reflection of the flash seen in the eyes of people in color flash photos. |
| `FinalOperation` | boolean | No | Return the processed file (File Contents) as opposed to just an Operation ID. Review https://support.encodian.com/hc/en-gb/articles/360010509573 before using. |
| `FileContentBase64` | string | No | Base64-encoded image content. If provided, this will be used instead of FileContent/FilePath. |
| `AutoRotateConfidenceLevel` | integer | No | Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied. Default is 40. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Combine Arrays

**Slug:** `ENCODIAN_COMBINE_ARRAYS`

Tool to combine two JSON arrays by matching a key attribute. Use when you need to merge data from two arrays based on a common identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | The JSON array or object to evaluate |
| `path` | string | No | Select a specific node within the 'Data' using a JSONPath expression |
| `dataKey` | string | Yes | The key attribute to be used when combining 'Data' to 'Merge Data' |
| `mergeData` | string | Yes | The JSON array or object to evaluate and combine into 'Data' |
| `mergeDataKey` | string | No | The key attribute to be used when combining 'Merge Data' to 'Data'. If not provided, the 'Data Key' value will be used |
| `fieldsToMerge` | string | No | Specify the fields to be combined as a comma-delimited list, for example: Forename, Age (If not supplied, all fields will be merged) |
| `mergeDataPath` | string | No | Select a specific node within the 'Merge Data' using a JSONPath expression |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compare Text

**Slug:** `ENCODIAN_COMPARE_TEXT`

Tool to compare two text strings and determine if they match. Use when you have two strings and need to verify if they are equal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ignoreCase` | boolean | No | Whether to ignore case when comparing the text values. |
| `primaryText` | string | Yes | The first text value to compare. |
| `secondaryText` | string | Yes | The second text value to compare. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compare Word Documents

**Slug:** `ENCODIAN_COMPARE_WORD_DOCUMENTS`

Tool to compare two Microsoft Word or PDF documents and generate a document with tracked changes. Use when you need to identify differences between two document versions. The output document highlights insertions, deletions, and modifications with the specified author name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `author` | string | No | Set the name of the author used to denote differences in the output document. |
| `ignoreFields` | boolean | No | Specifies whether to compare differences in fields. |
| `ignoreTables` | boolean | No | Specifies whether to compare the differences in data contained in tables. |
| `fileContentOne` | string | Yes | The file content of the first Microsoft Word or PDF file to compare, encoded as base64 string. |
| `fileContentTwo` | string | Yes | The file content of the second Microsoft Word or PDF file to compare, encoded as base64 string. |
| `ignoreComments` | boolean | No | Specifies whether to compare differences in comments. |
| `caseInsensitive` | boolean | No | Specifies whether to compare differences in documents as case insensitive. |
| `ignoreFootnotes` | boolean | No | Specifies whether to compare differences in footnotes and endnotes. |
| `ignoreTextboxes` | boolean | No | Specifies whether to compare differences in the data contained within text boxes. |
| `ignoreFormatting` | boolean | No | Specifies whether to ignore document formatting differences. |
| `ignoreHeadersAndFooters` | boolean | No | Specifies whether to compare differences in the data contained within headers and footers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compress Image

**Slug:** `ENCODIAN_COMPRESS_IMAGE`

Tool to compress an image in JPG or PNG format. Use when you need to reduce the file size of an image while maintaining format compatibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileName` | string | Yes | Filename of the source image including extension, e.g., 'image.png'. |
| `FilePath` | string | No | Absolute path to a local image file. If provided, this will be used instead of FileContent. |
| `ImageType` | string ("JPG" | "PNG") | Yes | Image file format to compress. |
| `FileContent` | object | No | The source image file to compress. |
| `FileContentBase64` | string | No | Base64-encoded image content. If provided, this will be used instead of FileContent/FilePath. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compress PDF

**Slug:** `ENCODIAN_COMPRESS_PDF`

Tool to compress a PDF document by optimizing images, removing unused objects, and applying various compression techniques. Use when you need to reduce PDF file size while maintaining readability and functionality.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FilePath` | string | No | Absolute path to a local PDF file. If provided, this will be used instead of FileContent. |
| `FileContent` | object | No | The source PDF file to compress. |
| `ImageQuality` | integer | No | Sets the quality for compressed images: 1 > 100 |
| `ResizeImages` | boolean | No | If 'Compress Images' and 'Resize Images' are enabled, images will be resized where the image resolution is greater than the specified 'Max Resolution' property. |
| `UnembedFonts` | boolean | No | Remove all embedded fonts. The document size will decrease but the document may become unreadable if the correct font is not installed on the user's machine. |
| `FlattenFields` | boolean | No | Flatten all fields contained within the PDF document (AcroForms only). |
| `MaxResolution` | integer | No | Specifies the maximum resolution of images (dpi), if the image has a higher resolution it will be scaled dynamically. |
| `CompressImages` | boolean | No | Contained images will be compressed, aligned to the value of the 'Image Quality' property. |
| `DeleteAnnotations` | boolean | No | Delete all annotations contained within the PDF document. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, this will be used instead of FileContent/FilePath. |
| `RemovePrivateInfo` | boolean | No | Remove private information from the PDF document, i.e. page piece information. |
| `FlattenAnnotations` | boolean | No | Flatten all annotations contained within the PDF document. |
| `RemoveUnusedObjects` | boolean | No | Remove all unused objects (i.e. objects which do not have a reference) are removed from PDF document. |
| `RemoveUnusedStreams` | boolean | No | Remove all unused resources from the PDF document. |
| `LinkDuplicateStreams` | boolean | No | Link duplicate streams and store them as a single object. This can decrease document size in some cases (for example, where the same document was merged multiple times). |
| `AllowReusePageContent` | boolean | No | Page contents will be reused when the PDF document is optimized for equal pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Concatenate Text

**Slug:** `ENCODIAN_CONCATENATE_TEXT`

Tool to concatenate an array of text values with an optional delimiter. Use when you need to combine multiple strings into a single text value with optional separator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `textList` | array | Yes | The array of text values to concatenate |
| `delimiter` | string | No | The delimiter to place between the concatenated text values |
| `trimResult` | boolean | No | Set whether white-space should be trimmed from the processed text value |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Array to JSON

**Slug:** `ENCODIAN_CONVERT_ARRAY_TO_JSON`

Tool to convert an array to a named JSON object. Use when you need to wrap an array in a JSON object with a specific key name, optionally selecting a specific array from nested JSON using JSONPath.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | An array or a JSON object to select an array for conversion to a named JSON object |
| `name` | string | Yes | The JSON node name to contain the array provided or selected |
| `path` | string | No | Select a specific array within the 'data' using a JSONPath expression |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Array to XML

**Slug:** `ENCODIAN_CONVERT_ARRAY_TO_XML`

Tool to convert a JSON array to XML format. Use when you need to transform JSON data into XML structure with custom root and item node names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | An array or a JSON object to select an array for conversion to a XML object |
| `item` | string | Yes | The name of the item node XML for each array item |
| `path` | string | No | Select a specific array within the 'Data' using a JSONPath expression |
| `root` | string | Yes | The name of the root XML node |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert File to PDF

**Slug:** `ENCODIAN_CONVERT_FILE_TO_PDF`

Tool to convert a file to PDF format. Use when you need to transform documents (Word, Excel, PowerPoint, text files, etc.) into PDF format with optional bookmarks, markup removal, and PDF/A compliance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileName` | string | Yes | The filename of the source file with extension (e.g., 'document.docx', 'spreadsheet.xlsx'). The file extension is mandatory. |
| `FilePath` | string | No | Absolute path to a local file (strictly within the repository). |
| `CultureName` | string | No | Change the thread culture used to process the request (e.g., 'en-US', 'fr-FR'). |
| `FileContent` | object | No | The file to convert to PDF. |
| `FinalOperation` | boolean | No | Return the processed file content as opposed to just an Operation ID. Set to true to get the file content in the response. |
| `outputFilename` | string | Yes | The filename of the output PDF document (e.g., 'output.pdf'). |
| `pdfaCompliance` | boolean | No | Set PDF/A Compliance option. If true, the output will comply with the specified PDF/A standard. |
| `FileContentBase64` | string | No | Base64-encoded file content. If provided, this will be used instead of FileContent/FilePath. |
| `GenerateBookmarks` | boolean | No | Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF. |
| `pdfaComplianceLevel` | string ("PDF_A_1A" | "PDF_A_1B" | "PDF_A_2A" | "PDF_A_3A" | "PDF_A_2B" | "PDF_A_2U" | "PDF_A_3B" | "PDF_A_3U" | "v_1_3" | "v_1_4" | "v_1_5" | "v_1_6" | "v_1_7" | "PDF_X_1A" | "PDF_X_3") | No | PDF/A compliance levels supported by Encodian. |
| `removeDocumentMarkup` | boolean | No | Set MS Office document comments and tracked changes removal option. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert HTML to Image

**Slug:** `ENCODIAN_CONVERT_HTML_TO_IMAGE`

Tool to convert HTML content to an image. Use when you need to render HTML as an image file, supporting URL, raw HTML string, or HTML file content with optional JavaScript execution and CSS styling control.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Url` | string | No | The URL of the web page to convert to an image. Provide either Url, htmlData, or fileContent. |
| `delay` | integer | No | Set the delay in milliseconds between the HTML being received and the conversion to allow time for JavaScript to load. |
| `cssType` | string ("Screen" | "Print") | No | Set whether the standard or print style sheets should be used for HTML conversion. |
| `htmlData` | string | No | The HTML content which will be converted to an image. Provide either Url, htmlData, or fileContent. |
| `imgWidth` | integer | No | Set the fixed image width in pixels. |
| `imgHeight` | integer | No | Set the fixed image height in pixels. |
| `fileContent` | string | No | Base64-encoded file content of the source HTML file. Provide either Url, htmlData, or fileContent. |
| `decodeHtmlData` | boolean | No | Set whether the data provided in the 'htmlData' field should be decoded. |
| `enableJavaScript` | boolean | No | Enable or disable JavaScript during HTML rendering. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert HTML to PDF (V2)

**Slug:** `ENCODIAN_CONVERT_HTML_TO_PDF_V2`

Tool to convert HTML content or a URL to PDF format (V2). Use when you need to transform HTML strings, HTML files, or live web pages into PDF documents with advanced options like custom page sizes, margins, JavaScript support, and bookmarks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Url` | string | No | The URL of the web page to convert to a PDF document. Use this instead of htmlData to convert a live webpage. |
| `delay` | integer | No | Set the delay in milliseconds between the HTML being received and the conversion to allow time for JavaScript to load. |
| `scale` | number | No | Set a scale value between 0.1 and 2.0 to zoom in or out on the HTML content. |
| `cssType` | string ("Screen" | "Print") | No | CSS type options for HTML to PDF conversion. |
| `htmlData` | string | No | The HTML content to convert to a PDF document. Provide raw HTML string with tags. |
| `pageSize` | string ("Default" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "B4" | "B5" | "EnvelopeDL" | "Executive" | "Folio" | "Ledger" | "Legal" | "Letter" | "Quarto" | "Statement" | "Tabloid" | "Custom") | No | Page size options for PDF output. |
| `viewPort` | string ("Default" | "Mobile" | "Tablet" | "Laptop" | "LaptopL" | "FourK") | No | Viewport options for rendering HTML. |
| `createToC` | boolean | No | Automatically create a Table of Contents based on the headings contained within the HTML. |
| `marginTop` | number | No | Set the top margin value in pixels. |
| `pageWidth` | integer | No | Set the page width value in pixels. Only relevant when pageSize is Custom. |
| `marginLeft` | number | No | Set the left margin value in pixels. |
| `pageHeight` | integer | No | Set the page height value in pixels. Only relevant when pageSize is Custom. |
| `fileContent` | string | No | The file content of the source HTML file encoded as base64 string. Use this to provide HTML from a file. |
| `marginRight` | number | No | Set the right margin value in pixels. |
| `marginBottom` | number | No | Set the bottom margin value in pixels. |
| `decodeHtmlData` | boolean | No | Set whether the data provided in the 'htmlData' field should be decoded. |
| `createBookmarks` | boolean | No | Automatically create bookmarks based on the headings contained within the HTML. |
| `pageOrientation` | string ("Portrait" | "Landscape") | No | Page orientation options. |
| `enableHyperlinks` | boolean | No | Enable or disable hyperlinks in the output PDF. |
| `enableJavaScript` | boolean | No | Enable or disable JavaScript execution during conversion. |
| `pageRotationAngle` | string ("None" | "Rotate90" | "Rotate180" | "Rotate270") | No | Page rotation angle options. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert HTML to Word

**Slug:** `ENCODIAN_CONVERT_HTML_TO_WORD`

Tool to convert HTML content to Word (DOCX) format. Use when you need to transform HTML documents, web pages, or HTML strings into Word documents with customizable page settings, margins, and compliance levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `htmlUrl` | string | No | The web address to the web page which will be converted to a Word document. Provide either htmlData, htmlUrl, or fileContent. |
| `FileName` | string | No | The filename of the source HTML file with extension (e.g., 'file.html'). The file extension is mandatory. |
| `encoding` | string ("UTF8" | "UTF7" | "UTF32" | "ASCII" | "Unicode" | "BigEndianUnicode") | No | Encoding types supported for HTML conversion. |
| `htmlData` | string | No | The HTML content which will be converted to a Word document. Provide either htmlData, htmlUrl, or fileContent. |
| `pageSize` | string ("Default" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "B4" | "B5" | "EnvelopeDL" | "Executive" | "Folio" | "Ledger" | "Legal" | "Letter" | "Quarto" | "Statement" | "Tabloid" | "Custom") | No | Page size options for Word document. |
| `MarginTop` | number | No | Set the top margin value in points. The default value is -1, whereby a negative value does not change the existing page margin value. |
| `pageWidth` | integer | No | Set the page width value in pixels. Used when pageSize is set to Custom. |
| `MarginLeft` | number | No | Set the left margin value in points. The default value is -1, whereby a negative value does not change the existing page margin value. |
| `pageHeight` | integer | No | Set the page height value in pixels. Used when pageSize is set to Custom. |
| `MarginRight` | number | No | Set the right margin value in points. The default value is -1, whereby a negative value does not change the existing page margin value. |
| `fileContent` | string | No | Base64-encoded content of the source HTML file. Provide either htmlData, htmlUrl, or fileContent. |
| `MarginBottom` | number | No | Set the bottom margin value in points. The default value is -1, whereby a negative value does not change the existing page margin value. |
| `FinalOperation` | boolean | No | Return the processed file content as opposed to just an Operation ID. Set to true to get the file content in the response. |
| `decodeHtmlData` | boolean | No | Set whether the data provided in the HTML Data field should be decoded. |
| `outputFilename` | string | Yes | The filename of the output DOCX document (e.g., 'output.docx'). |
| `pageOrientation` | string ("Portrait" | "Landscape") | No | Page orientation options. |
| `WordComplianceLevel` | string ("Ecma" | "Transitional" | "Strict") | No | Word compliance levels for HTML conversion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Image to Grayscale

**Slug:** `ENCODIAN_CONVERT_IMAGE_TO_GRAYSCALE`

Tool to convert an image to grayscale. Use when you need to remove color from an image and convert it to shades of gray.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileContent` | string | Yes | The file content of the source image file, base64-encoded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Image to PDF

**Slug:** `ENCODIAN_CONVERT_IMAGE_TO_PDF`

Tool to convert an image file to PDF format with optional OCR. Use when you need to transform image files (PNG, JPG, etc.) into PDF documents, optionally extracting text via OCR.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ocrType` | string ("None" | "AI" | "Standard") | No | Set the type of OCR to be applied: None (no OCR), Standard (traditional OCR), or AI (AI-powered OCR). |
| `filePath` | string | No | Absolute path to a local image file (strictly within the repository). If provided, this will be used instead of fileContent. |
| `fileContent` | object | No | The image file to convert. |
| `ocrLanguage` | string ("Albanian" | "Arabic" | "Azerbaijani" | "Basque" | "Belarusian" | "Bengali" | "Bosnian" | "Bulgarian" | "Burmese" | "Catalan" | "ChineseSimplified" | "ChineseTraditional" | "Croatian" | "Czech" | "Danish" | "Dutch" | "English" | "Estonian" | "Finnish" | "French" | "Georgian" | "German" | "Greek" | "Gujarati" | "Hebrew" | "Hindi" | "Hungarian" | "Icelandic" | "Indonesian" | "Italian" | "Japanese" | "Kannada" | "Kazakh" | "Khmer" | "Korean" | "Kurdish" | "Kyrgyz" | "Laotian" | "Latin" | "Latvian" | "Lithuanian" | "Macedonian" | "Maharashtra" | "Malay" | "Malayalam" | "Maltese" | "Nepali" | "Norwegian" | "Oriya" | "Panjabi" | "Persian" | "Polish" | "Portuguese" | "Pushto" | "Romanian" | "Russian" | "Sanskrit" | "Serbian" | "Singhalese" | "Slovakian" | "Slovenian" | "Spanish" | "Swahili" | "Swedish" | "Syriac" | "Tamil" | "Telugu" | "Thai" | "Turkish" | "Ukrainian" | "Urdu" | "Uzbek" | "Vietnamese" | "Welsh" | "Yiddish") | No | Set the language to use for OCR processing. |
| `fileContentBase64` | string | No | Base64-encoded image content. If provided, this will be used instead of fileContent/filePath. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert JSON to Excel

**Slug:** `ENCODIAN_CONVERT_JSON_TO_EXCEL`

Tool to convert JSON data to Excel format. Use when you need to transform JSON arrays into Excel spreadsheets with customizable formatting options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `row` | integer | No | The first row to be written to (0-indexed). |
| `column` | integer | No | The first column to be written to (0-indexed). |
| `jsonData` | string | No | The JSON data to be converted to an Excel document. Must be a valid JSON string representing an array of objects. |
| `dateFormat` | string | No | Set the date and time format. See: https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings |
| `cultureName` | string | No | Change the thread culture used to process the request. |
| `fileContent` | string | No | Base64-encoded content of a source JSON file. Use this instead of jsonData if you have a JSON file. |
| `ignoreNulls` | boolean | No | Ignore JSON properties which contain null values. |
| `isTitleBold` | boolean | No | Set the title to bold. |
| `numericFormat` | string | No | Set the numeric format. See: https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings |
| `worksheetName` | string | No | The name of the worksheet that the JSON data is added to. |
| `outputFilename` | string | No | The filename of the output Excel document. |
| `titleFontColour` | string ("AliceBlue" | "AntiqueWhite" | "Aqua" | "Aquamarine" | "Azure" | "Beige" | "Bisque" | "Black" | "BlanchedAlmond" | "Blue" | "BlueViolet" | "Brown" | "BurlyWood" | "CadetBlue" | "Chartreuse" | "Chocolate" | "Coral" | "CornflowerBlue" | "Cornsilk" | "Crimson" | "Cyan" | "DarkBlue" | "DarkCyan" | "DarkGoldenrod" | "DarkGray" | "DarkGreen" | "DarkKhaki" | "DarkMagenta" | "DarkOliveGreen" | "DarkOrange" | "DarkOrchid" | "DarkRed" | "DarkSalmon" | "DarkSeaGreen" | "DarkSlateBlue" | "DarkSlateGray" | "DarkTurquoise" | "DarkViolet" | "DeepPink" | "DeepSkyBlue" | "DimGray" | "DodgerBlue" | "Firebrick" | "FloralWhite" | "ForestGreen" | "Fuchsia" | "Gainsboro" | "GhostWhite" | "Gold" | "Goldenrod" | "Gray" | "Green" | "GreenYellow" | "Honeydew" | "HotPink" | "IndianRed" | "Indigo" | "Ivory" | "Khaki" | "Lavender" | "LavenderBlush" | "LawnGreen" | "LemonChiffon" | "LightBlue" | "LightCoral" | "LightCyan" | "LightGoldenrodYellow" | "LightGray" | "LightGreen" | "LightPink" | "LightSalmon" | "LightSeaGreen" | "LightSkyBlue" | "LightSlateGray" | "LightSteelBlue" | "LightYellow" | "Lime" | "LimeGreen" | "Linen" | "Magenta" | "Maroon" | "MediumAquamarine" | "MediumBlue" | "MediumOrchid" | "MediumPurple" | "MediumSeaGreen" | "MediumSlateBlue" | "MediumSpringGreen" | "MediumTurquoise" | "MediumVioletRed" | "MidnightBlue" | "MintCream" | "MistyRose" | "Moccasin" | "NavajoWhite" | "Navy" | "OldLace" | "Olive" | "OliveDrab" | "Orange" | "OrangeRed" | "Orchid" | "PaleGoldenrod" | "PaleGreen" | "PaleTurquoise" | "PaleVioletRed" | "PapayaWhip" | "PeachPuff" | "Peru" | "Pink" | "Plum" | "PowderBlue" | "Purple" | "Red" | "RosyBrown" | "RoyalBlue" | "SaddleBrown" | "Salmon" | "SandyBrown" | "SeaGreen" | "SeaShell" | "Sienna" | "Silver" | "SkyBlue" | "SlateBlue" | "SlateGray" | "Snow" | "SpringGreen" | "SteelBlue" | "Tan" | "Teal" | "Thistle" | "Tomato" | "Transparent" | "Turquoise" | "Violet" | "Wheat" | "White" | "WhiteSmoke" | "Yellow" | "YellowGreen") | No | Enum for title font color options. |
| `isTitleTextWrapped` | boolean | No | Set whether a title's text is wrapped. |
| `convertNumericAndDate` | boolean | No | Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date'. |
| `ignoreAttributeTitles` | boolean | No | Ignores titles of JSON attributes when converting JSON to Excel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert JSON to XML

**Slug:** `ENCODIAN_CONVERT_JSON_TO_XML`

Tool to convert JSON data to XML format. Use when you need to transform JSON strings into XML documents with customizable root element names and array attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `json` | string | Yes | The JSON to convert to XML. Must be a valid JSON string. |
| `rootName` | string | No | Set the name of the 'Root' XML element. If not provided, a default root element will be used. |
| `includeArrayAttribute` | boolean | No | Set whether to include an array attribute for collections in the XML output. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Time Zone

**Slug:** `ENCODIAN_CONVERT_TIME_ZONE_ENC`

Tool to convert a date and time value from one time zone to another using Encodian's time zone conversion API. Use when you need to transform timestamps between different time zones (e.g., UTC to Eastern Standard Time).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | The date and time value to convert in ISO 8601 format (e.g., '2024-02-14T12:00:00Z') |
| `cultureName` | string | No | Optional culture name to change the thread culture used to process the request (e.g., 'en-US', 'fr-FR') |
| `newTimeZone` | string ("Default" | "AUSCentralStandardTime" | "AUSEasternStandardTime" | "AfghanistanStandardTime" | "AlaskanStandardTime" | "AleutianStandardTime" | "AltaiStandardTime" | "ArabStandardTime" | "ArabianStandardTime" | "ArabicStandardTime" | "ArgentinaStandardTime" | "AstrakhanStandardTime" | "AtlanticStandardTime" | "AusCentralWStandardTime" | "AzerbaijanStandardTime" | "AzoresStandardTime" | "BahiaStandardTime" | "BangladeshStandardTime" | "BelarusStandardTime" | "BougainvilleStandardTime" | "CanadaCentralStandardTime" | "CapeVerdeStandardTime" | "CaucasusStandardTime" | "CenAustraliaStandardTime" | "CentralAmericaStandardTime" | "CentralAsiaStandardTime" | "CentralBrazilianStandardTime" | "CentralEuropeStandardTime" | "CentralEuropeanStandardTime" | "CentralPacificStandardTime" | "CentralStandardTime" | "CentralStandardTimeMexico" | "ChathamIslandsStandardTime" | "ChinaStandardTime" | "CubaStandardTime" | "DatelineStandardTime" | "EAfricaStandardTime" | "EAustraliaStandardTime" | "EEuropeStandardTime" | "ESouthAmericaStandardTime" | "EasterIslandStandardTime" | "EasternStandardTime" | "EasternStandardTimeMexico" | "EgyptStandardTime" | "EkaterinburgStandardTime" | "FLEStandardTime" | "FijiStandardTime" | "GMTStandardTime" | "GTBStandardTime" | "GeorgianStandardTime" | "GreenlandStandardTime" | "GreenwichStandardTime" | "HaitiStandardTime" | "HawaiianStandardTime" | "IndiaStandardTime" | "IranStandardTime" | "IsraelStandardTime" | "JordanStandardTime" | "KaliningradStandardTime" | "KamchatkaStandardTime" | "KoreaStandardTime" | "LibyaStandardTime" | "LineIslandsStandardTime" | "LordHoweStandardTime" | "MagadanStandardTime" | "MagallanesStandardTime" | "MarquesasStandardTime" | "MauritiusStandardTime" | "MidAtlanticStandardTime" | "MiddleEastStandardTime" | "MontevideoStandardTime" | "MoroccoStandardTime" | "MountainStandardTime" | "MountainStandardTimeMexico" | "MyanmarStandardTime" | "NCentralAsiaStandardTime" | "NamibiaStandardTime" | "NepalStandardTime" | "NewZealandStandardTime" | "NewfoundlandStandardTime" | "NorfolkStandardTime" | "NorthAsiaEastStandardTime" | "NorthAsiaStandardTime" | "NorthKoreaStandardTime" | "OmskStandardTime" | "PacificSAStandardTime" | "PacificStandardTime" | "PacificStandardTimeMexico" | "PakistanStandardTime" | "ParaguayStandardTime" | "QyzylordaStandardTime" | "RomanceStandardTime" | "RussiaTimeZone10" | "RussiaTimeZone11" | "RussiaTimeZone3" | "RussianStandardTime" | "SAEasternStandardTime" | "SAPacificStandardTime" | "SAWesternStandardTime" | "SEAsiaStandardTime" | "SaintPierreStandardTime" | "SakhalinStandardTime" | "SamoaStandardTime" | "SaoTomeStandardTime" | "SaratovStandardTime" | "SingaporeStandardTime" | "SouthAfricaStandardTime" | "SouthSudanStandardTime" | "SriLankaStandardTime" | "SudanStandardTime" | "SyriaStandardTime" | "TaipeiStandardTime" | "TasmaniaStandardTime" | "TocantinsStandardTime" | "TokyoStandardTime" | "TomskStandardTime" | "TongaStandardTime" | "TransbaikalStandardTime" | "TurkeyStandardTime" | "TurksAndCaicosStandardTime" | "USEasternStandardTime" | "USMountainStandardTime" | "UTC" | "UTC02" | "UTC08" | "UTC09" | "UTC11" | "UTC12" | "UTC13" | "UlaanbaatarStandardTime" | "VenezuelaStandardTime" | "VladivostokStandardTime" | "VolgogradStandardTime" | "WAustraliaStandardTime" | "WCentralAfricaStandardTime" | "WEuropeStandardTime" | "WMongoliaStandardTime" | "WestAsiaStandardTime" | "WestBankStandardTime" | "WestPacificStandardTime" | "YakutskStandardTime" | "YukonStandardTime") | Yes | The target time zone to convert the date value to |
| `currentTimeZone` | string ("Default" | "AUSCentralStandardTime" | "AUSEasternStandardTime" | "AfghanistanStandardTime" | "AlaskanStandardTime" | "AleutianStandardTime" | "AltaiStandardTime" | "ArabStandardTime" | "ArabianStandardTime" | "ArabicStandardTime" | "ArgentinaStandardTime" | "AstrakhanStandardTime" | "AtlanticStandardTime" | "AusCentralWStandardTime" | "AzerbaijanStandardTime" | "AzoresStandardTime" | "BahiaStandardTime" | "BangladeshStandardTime" | "BelarusStandardTime" | "BougainvilleStandardTime" | "CanadaCentralStandardTime" | "CapeVerdeStandardTime" | "CaucasusStandardTime" | "CenAustraliaStandardTime" | "CentralAmericaStandardTime" | "CentralAsiaStandardTime" | "CentralBrazilianStandardTime" | "CentralEuropeStandardTime" | "CentralEuropeanStandardTime" | "CentralPacificStandardTime" | "CentralStandardTime" | "CentralStandardTimeMexico" | "ChathamIslandsStandardTime" | "ChinaStandardTime" | "CubaStandardTime" | "DatelineStandardTime" | "EAfricaStandardTime" | "EAustraliaStandardTime" | "EEuropeStandardTime" | "ESouthAmericaStandardTime" | "EasterIslandStandardTime" | "EasternStandardTime" | "EasternStandardTimeMexico" | "EgyptStandardTime" | "EkaterinburgStandardTime" | "FLEStandardTime" | "FijiStandardTime" | "GMTStandardTime" | "GTBStandardTime" | "GeorgianStandardTime" | "GreenlandStandardTime" | "GreenwichStandardTime" | "HaitiStandardTime" | "HawaiianStandardTime" | "IndiaStandardTime" | "IranStandardTime" | "IsraelStandardTime" | "JordanStandardTime" | "KaliningradStandardTime" | "KamchatkaStandardTime" | "KoreaStandardTime" | "LibyaStandardTime" | "LineIslandsStandardTime" | "LordHoweStandardTime" | "MagadanStandardTime" | "MagallanesStandardTime" | "MarquesasStandardTime" | "MauritiusStandardTime" | "MidAtlanticStandardTime" | "MiddleEastStandardTime" | "MontevideoStandardTime" | "MoroccoStandardTime" | "MountainStandardTime" | "MountainStandardTimeMexico" | "MyanmarStandardTime" | "NCentralAsiaStandardTime" | "NamibiaStandardTime" | "NepalStandardTime" | "NewZealandStandardTime" | "NewfoundlandStandardTime" | "NorfolkStandardTime" | "NorthAsiaEastStandardTime" | "NorthAsiaStandardTime" | "NorthKoreaStandardTime" | "OmskStandardTime" | "PacificSAStandardTime" | "PacificStandardTime" | "PacificStandardTimeMexico" | "PakistanStandardTime" | "ParaguayStandardTime" | "QyzylordaStandardTime" | "RomanceStandardTime" | "RussiaTimeZone10" | "RussiaTimeZone11" | "RussiaTimeZone3" | "RussianStandardTime" | "SAEasternStandardTime" | "SAPacificStandardTime" | "SAWesternStandardTime" | "SEAsiaStandardTime" | "SaintPierreStandardTime" | "SakhalinStandardTime" | "SamoaStandardTime" | "SaoTomeStandardTime" | "SaratovStandardTime" | "SingaporeStandardTime" | "SouthAfricaStandardTime" | "SouthSudanStandardTime" | "SriLankaStandardTime" | "SudanStandardTime" | "SyriaStandardTime" | "TaipeiStandardTime" | "TasmaniaStandardTime" | "TocantinsStandardTime" | "TokyoStandardTime" | "TomskStandardTime" | "TongaStandardTime" | "TransbaikalStandardTime" | "TurkeyStandardTime" | "TurksAndCaicosStandardTime" | "USEasternStandardTime" | "USMountainStandardTime" | "UTC" | "UTC02" | "UTC08" | "UTC09" | "UTC11" | "UTC12" | "UTC13" | "UlaanbaatarStandardTime" | "VenezuelaStandardTime" | "VladivostokStandardTime" | "VolgogradStandardTime" | "WAustraliaStandardTime" | "WCentralAfricaStandardTime" | "WEuropeStandardTime" | "WMongoliaStandardTime" | "WestAsiaStandardTime" | "WestBankStandardTime" | "WestPacificStandardTime" | "YakutskStandardTime" | "YukonStandardTime") | No | The current time zone of the date value. Defaults to 'Default' if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert XML to JSON

**Slug:** `ENCODIAN_CONVERT_XML_TO_JSON`

Tool to convert XML strings to JSON format. Use when you need to transform XML data into a JSON representation for easier parsing or processing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `xml` | string | Yes | The XML string to convert to JSON format. |
| `omitRootObject` | boolean | No | Set whether the root object should be omitted in the resulting JSON. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Array Items

**Slug:** `ENCODIAN_COUNT_ARRAY_ITEMS`

Tool to count the number of items in a JSON array or object. Use when you need to determine the size of an array or evaluate specific nodes using JSONPath expressions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | The JSON array or object to evaluate. Must be a valid JSON string. |
| `path` | string | No | Select a specific node using a JSONPath expression to count items at that path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create QR Code

**Slug:** `ENCODIAN_CREATE_QR_CODE`

Tool to generate a QR code barcode image with customizable size, colors, border, and encoding options. Use when you need to create QR codes for URLs, contact information, or any text data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `width` | integer | No | QR code width in pixels. Defaults to 88. |
| `height` | integer | No | QR code height in pixels. Defaults to 88. |
| `sizeMode` | string ("None" | "Nearest" | "Fixed" | "Interpolation") | No | QR code size mode options. |
| `backColor` | string | No | Background color in HTML hex format. Defaults to #FFFFFF (white). |
| `foreColor` | string | No | Foreground color in HTML hex format. Defaults to #000000 (black). |
| `encodeMode` | string ("Auto" | "Bytes" | "ECIEncoding" | "ExtendedCodetext" | "Utf16BEBOM" | "Utf8BOM") | No | QR code encoding mode. |
| `encodeType` | string ("Auto" | "ForceMicroQR" | "ForceQR") | No | QR code type encoding options. |
| `resolution` | integer | No | Image resolution in DPI (dots per inch). Defaults to 96. |
| `barcodeData` | string | Yes | The string value used to generate the QR barcode. |
| `borderColor` | string | No | Border color in HTML hex format. Defaults to #000000 (black). |
| `borderStyle` | string ("Dash" | "DashDot" | "DashDotDot" | "Dot" | "Solid") | No | Border style options for QR code. |
| `borderWidth` | integer | No | Border width in pixels. Defaults to 2. |
| `visibleBorder` | boolean | No | Whether to display a border around the QR code. Defaults to true. |
| `captionAboveFont` | string | No | Font name for caption above. |
| `captionAboveText` | string | No | Text to display above the QR code. |
| `captionBelowFont` | string | No | Font name for caption below. |
| `captionBelowText` | string | No | Text to display below the QR code. |
| `textEncodingType` | string ("Default" | "Latin1" | "BigEndianUnicode" | "UTF16" | "UTF8" | "UTF7" | "ASCII") | No | Text encoding options for QR code data. |
| `captionAboveColor` | string | No | Caption above text color in HTML hex format. |
| `captionBelowColor` | string | No | Caption below text color in HTML hex format. |
| `barcodeImageFormat` | string ("PNG" | "JPG" | "SVG" | "BMP" | "TIFF" | "GIF") | Yes | Output image format for the QR code. |
| `captionAboveNoWrap` | boolean | No | Prevent text wrapping for caption above. |
| `captionBelowNoWrap` | boolean | No | Prevent text wrapping for caption below. |
| `captionAboveFontSize` | integer | No | Font size for caption above in points. |
| `captionBelowFontSize` | integer | No | Font size for caption below in points. |
| `captionAboveAlignment` | string ("Left" | "Center" | "Right") | No | Caption text alignment options. |
| `captionBelowAlignment` | string ("Left" | "Center" | "Right") | No | Caption text alignment options. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Format Text Case

**Slug:** `ENCODIAN_FORMAT_TEXT_CASE`

Tool to format text with various case transformations (uppercase, lowercase, title case, etc.). Use when you need to standardize or change the capitalization of text strings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text value to format. |
| `action` | string ("ToUpper" | "ToLower" | "ToUpperInvariant" | "ToLowerInvariant" | "ToTitleCase" | "ToSentenceCase" | "ToggleCase") | Yes | The formatting action to apply to the text value provided. Options: ToUpper (convert to uppercase), ToLower (convert to lowercase), ToUpperInvariant (culture-invariant uppercase), ToLowerInvariant (culture-invariant lowercase), ToTitleCase (capitalize first letter of each word), ToSentenceCase (capitalize first letter of sentence), ToggleCase (swap case of each character). |
| `cultureName` | string | No | Change the thread culture used to process the request. Optional parameter to specify culture-specific formatting rules (e.g., 'en-US', 'fr-FR'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Hash Data

**Slug:** `ENCODIAN_GENERAL_HASH`

Tool to compute a cryptographic hash (MD5, SHA256, etc.) of text or file data. Use when you need to verify integrity or generate digests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Case` | string ("Upper" | "Lower") | No | Character casing for the output hash: Upper \| Lower. |
| `Data` | string | Yes | The input to hash. For DataType=FILE, this should be a base64-encoded file content. |
| `DataType` | string ("Text" | "HEX" | "BASE64" | "FILE") | Yes | Format of the input data: Text \| HEX \| BASE64 \| FILE. |
| `OutputType` | string ("Text" | "HEX" | "BASE64") | Yes | Output format of the hash: Text \| HEX \| BASE64. |
| `EncodingType` | string | No | Character encoding used to process the data (e.g., 'utf-8'). |
| `DigestAlgorithm` | string ("SHA1" | "SHA256" | "SHA384" | "SHA512" | "MD5") | Yes | Hash algorithm to use: SHA1 \| SHA256 \| SHA384 \| SHA512 \| MD5. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unzip File

**Slug:** `ENCODIAN_GENERAL_UNZIP_FILE`

Extracts all files from a ZIP archive and returns their base64-encoded contents. Supports password-protected archives and optionally extracts files from nested folders. Use this when you need to access the contents of compressed archive files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | The archive file to unzip. |
| `password` | string | No | Password for encrypted archives, if required. |
| `recursive` | boolean | No | Whether to extract files from subfolders within the archive. If False, only root-level files are extracted. Defaults to True if not specified. |
| `local_path` | string | No | Absolute local file path strictly within the repository for the archive. |
| `file_content_base64` | string | No | Base64-encoded content of the archive. If provided, takes precedence over other sources. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Convert Excel Schema

**Slug:** `ENCODIAN_GET_CONVERT_EXCEL_SCHEMA`

Tool to retrieve the dynamic schema for Excel conversion operations. Returns the schema definition including required fields and available properties based on the specified output format. Use when you need to understand what parameters are available for converting Excel files to different formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outputFormat` | string | No | The output format to obtain the dynamic schema for. Valid values include: PDF, HTML, CSV, TXT, XLSX, XLS, XLTX, PNG, TIFF, XLSB, XLSM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Convert Word Schema

**Slug:** `ENCODIAN_GET_CONVERT_WORD_SCHEMA`

Tool to retrieve the dynamic JSON schema for Word document conversion operations. Use when you need to discover available parameters and their constraints for converting Word documents to various formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outputFormat` | string | No | The output format to obtain the dynamic schema for. Supported formats: PDF, DOCX, DOC, DOTX, RTF, HTML, TXT, PNG, TIFF, DOCM. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Convert CAD Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_CAD`

Tool to retrieve the dynamic schema for CAD file conversion operations. Returns the schema definition that specifies available parameters for converting CAD files to various output formats. Use when you need to understand the conversion parameters available for a specific output format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outputFormat` | string | No | The output format to obtain the dynamic schema for (e.g., PDF, BMP, GIF, JPG, PNG, TIFF). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Convert Image to PDF Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_IMAGE_TO_PDF`

Tool to retrieve the dynamic schema for Convert - Image to PDF operations. Use when you need to understand the available configuration options for image-to-PDF conversion based on OCR type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ocrType` | string ("None" | "AI" | "Standard") | No | OCR type options for image to PDF conversion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Convert PowerPoint Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_POWER_POINT`

Tool to retrieve the dynamic schema for PowerPoint conversion operations. Use when you need to understand the available parameters and requirements for converting PowerPoint files to different formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outputFormat` | string | No | The output format to obtain the dynamic schema for (e.g., 'pdf', 'html', 'png'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Convert Visio Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_VISIO`

Tool to retrieve the dynamic schema for Visio file conversion. Returns format-specific field definitions based on the selected output format (PDF, PNG, SVG, etc.). Use when you need to understand what parameters are available for converting Visio files to a specific format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `outputFormat` | string ("pdf" | "bmp" | "gif" | "html" | "jpg" | "png" | "svg" | "tiff" | "vsdx") | No | Output format options for Visio conversion. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Create Barcode Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_CREATE_BARCODE`

Tool to retrieve the dynamic schema for creating a barcode. Use this to understand the required parameters and configuration options for a specific barcode type before creating it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `barcodeType` | string ("AustraliaPost" | "Aztec" | "Codabar" | "CodablockF" | "Code11" | "Code39Standard" | "Code39Extended" | "Code128" | "Code16K" | "DatabarExpanded" | "DatabarExpandedStacked" | "DatabarLimited" | "DatabarOmniDirectional" | "DatabarStacked" | "DatabarStackedOmniDirectional" | "DatabarTruncated" | "DataMatrix" | "DotCode" | "EAN8" | "EAN13" | "GS1Code128" | "GS1CodablockF" | "Interleaved2of5" | "ISBN" | "ISMN" | "ISSN" | "ITF6" | "ITF14" | "MaxiCode" | "Pdf417" | "Planet" | "Postnet" | "Standard2of5" | "UPCA" | "UpcaGs1Code128Coupon" | "UpcaGs1DatabarCoupon" | "UPCE") | No | Supported barcode types for schema retrieval. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Crop Image Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_CROP_IMAGE`

Tool to retrieve the dynamic schema for the Crop Image action. Returns an OpenAPI-style schema definition that varies based on the specified crop type (Border or Rectangle).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cropType` | string ("Border" | "Rectangle") | No | Enum for supported crop types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dynamic Schema for HTTP Request

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_SEND_HTTP_REQUEST`

Tool to retrieve the dynamic schema for the HTTP Request utility based on authentication type. Use when you need to understand what parameters are required for sending HTTP requests with specific authentication methods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `authenticationType` | string | No | The Authentication Type to obtain the dynamic schema for. Common values include 'Basic', 'OAuth', 'ApiKey', etc. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Word Insert Text Schema

**Slug:** `ENCODIAN_GET_DYNAMIC_SCHEMA_WORD_INSERT_TEXT`

Tool to retrieve the dynamic schema for Word Insert Text operations. Use when you need to understand the available parameters and their types for inserting text into Word documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `searchBy` | string ("Element" | "Text") | No | Search type for Word Insert Text schema. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get File Properties

**Slug:** `ENCODIAN_GET_FILE_PROPERTIES`

Tool to retrieve properties of a file. Attempts multiple Encodian Filer endpoints and fallbacks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `BlobName` | string | Yes | Path or name of the blob/file to inspect. |
| `ContainerName` | string | Yes | Name of the container holding the file. |
| `IncludeMetadata` | boolean | No | Whether to include user-defined metadata in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status for AIRunPromptText

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_AI_RUN_PROMPT_TEXT`

Tool to get the operation status of an AIRunPromptText operation. Use when you need to check the completion status of a previously initiated AI prompt operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | Yes | Retrieve the operation status of a AIRunPromptText operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status for Encodian Send to Filer

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_ENCODIAN_SEND_TO_FILER`

Tool to get the operation status for an Encodian Send to Filer operation. Use when you need to check the completion status and retrieve results from a previously submitted Send to Filer operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | No | Retrieve the operation status of a GetOperationStatusEncodianSendToFiler operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status Extract Image

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_EXTRACT_IMAGE`

Tool to retrieve the operation status of a PDF ExtractImage operation. Use when you need to check if an image extraction operation has completed, is queued, or has failed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | No | Retrieve the operation status of an ExtractImage operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status for ExtractTextRegion

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_EXTRACT_TEXT_REGION`

Tool to retrieve the operation status of an ExtractTextRegion operation. Use when you need to check if a text region extraction operation has completed and retrieve the extracted text results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | Yes | Retrieve the operation status of an ExtractTextRegion operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status File Only

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_FILE_ONLY`

Tool to retrieve operation status for file-only operations. Use when you need to check if an asynchronous file operation has completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | No | Retrieve the operation status for a file only operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status for Image Extract Text

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_IMAGE_EXTRACT_TEXT`

Tool to get the operation status of an ImageExtractText operation. Use when you need to check if an image text extraction operation has completed and retrieve the extracted text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | No | Retrieve the operation status of an ImageExtractText operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status for Multiple Files

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_MULTIPLE_FILES`

Tool to retrieve the operation status of a Word MultipleFiles operation. Use when you need to check the status and retrieve results of a previously submitted batch operation on multiple Word documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | No | Retrieve the operation status of a MultipleFiles operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status - PDF Split Barcode

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_PDF_SPLIT_BARCODE`

Tool to retrieve operation status for a PDF split barcode operation. Use when you need to check the status and results of an asynchronous PDF split operation initiated previously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | Yes | Retrieve the operation status of a PdfSplitBarcode operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operation Status for Split Document

**Slug:** `ENCODIAN_GET_OPERATION_STATUS_SPLIT_DOCUMENT`

Tool to retrieve the operation status of a PDF SplitDocument operation. Use when you need to check the progress or completion status of a previously initiated split document operation by providing its operation ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operationId` | string | No | Retrieve the operation status of a SplitDocument operation for the Operation ID provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sign PDF Schema

**Slug:** `ENCODIAN_GET_SIGN_PDF_SCHEMA`

Tool to retrieve the dynamic schema for PDF signing operations. Returns the schema definition including required fields and available properties based on the specified certificate type. Use when you need to understand what parameters are available for signing PDF documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `certificateType` | string | No | The certificate type to obtain the dynamic schema for. Valid values: Standard, Custom. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscription Status

**Slug:** `ENCODIAN_GET_SUBSCRIPTION_STATUS`

Tool to retrieve Encodian subscription status for Flowr and Vertr. Use when you need to check remaining credits, billing interval, subscription level, or expiry date.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resize Image

**Slug:** `ENCODIAN_IMAGE_RESIZE`

Tool to resize an image by percentage or dimensions. Use when you need to scale or reshape an image with optional aspect-ratio enforcement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FileName` | string | Yes | Filename of the source image including extension, e.g., 'image.png'. |
| `FilePath` | string | No | Absolute path to a local image file. If provided, this will be used instead of FileContent. |
| `ImageWidth` | integer | No | Target width in pixels. Required when ImageResizeType is 'Specific'. |
| `FileContent` | object | No | The source image file to resize. |
| `ImageHeight` | integer | No | Target height in pixels. Required when ImageResizeType is 'Specific' unless MaintainAspectRatio is true. |
| `ImageResizeType` | string ("Percentage" | "Specific") | Yes | Resize by Percentage or Specific dimensions. |
| `ImageResolution` | integer | No | Output DPI (dots per inch). Defaults to the source image resolution if omitted. |
| `ResizePercentage` | integer | No | Percentage to scale the image. Required when ImageResizeType is 'Percentage'. |
| `FileContentBase64` | string | No | Base64-encoded image content. If provided, this will be used instead of FileContent/FilePath. |
| `MaintainAspectRatio` | boolean | No | If true and ImageWidth is set, height is auto-determined; provided ImageHeight is ignored. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move File

**Slug:** `ENCODIAN_MOVE_FILE`

Tool to move a file between containers. Use when you need to relocate a blob within your storage without manually copying then deleting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Overwrite` | boolean | No | If true, overwrites the destination file if it already exists. |
| `SourceBlob` | string | Yes | Path of the source blob/file to move. |
| `DestinationBlob` | string | Yes | Path/name for the moved file in the destination container. |
| `SourceContainer` | string | Yes | Name of the container holding the source file. |
| `DestinationContainer` | string | Yes | Name of the container where to move the file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add PDF Header Footer

**Slug:** `ENCODIAN_PDF_ADD_HEADER_FOOTER`

Tool to add HTML header and footer to a PDF. Use when you need to embed consistent headers or footers across pages with margin and range options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ApplyTo` | string | No | DEPRECATED: Pages to apply header/footer to. This parameter is not currently supported by the API and should not be used. Use PageNumbers or IgnorePageNumbers directly instead. |
| `FileName` | string | Yes | Name of the source PDF file, including extension. |
| `FilePath` | string | No | Absolute local file path strictly within the repository. |
| `MarginTop` | number | No | Top margin in points. |
| `MarginLeft` | number | No | Left margin in points. |
| `ReturnFile` | boolean | No | When true (default), returns processed file content; when false, returns only OperationId. |
| `FileContent` | object | No | Binary content of the source PDF. Provide this if the file is not accessible by name. |
| `MarginRight` | number | No | Right margin in points. |
| `OperationId` | string | No | Advanced: parent operation identifier for chaining. |
| `PageNumbers` | array | No | Specific page numbers to include when ApplyTo = 'Specific'. |
| `MarginBottom` | number | No | Bottom margin in points. |
| `SkipFirstPage` | boolean | No | Whether to skip adding header/footer on the first page. |
| `FinalOperation` | boolean | No | If true, returns processed file content inline instead of only an operation ID. |
| `HtmlHeaderFooter` | string | Yes | HTML markup to embed as header or footer. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, takes precedence over FileContent/FilePath. |
| `IgnorePageNumbers` | array | No | Specific page numbers to exclude when ApplyTo = 'Specific'. |
| `HtmlHeaderFooterLocation` | string ("Header" | "Footer" | "Both") | Yes | Where to apply the HTML: Header, Footer, or Both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PDF Metadata

**Slug:** `ENCODIAN_PDF_GET_METADATA`

Extract comprehensive metadata and properties from PDF documents. Returns page count, dimensions, author/creator/producer information, creation/modification dates, PDF format version, compliance flags (PDF/A, PDF/UA), encryption status, text layer presence, and custom properties. Useful for document analysis, validation, and cataloging workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | PDF file to extract metadata from. |
| `Filename` | string | No | Original filename including extension. |
| `filePath` | string | No | Absolute path to a local PDF file. Use when a file reference is not available. Can be provided as 'filePath' (camelCase) or 'file_path' (snake_case). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Watermark PDF

**Slug:** `ENCODIAN_PDF_WATERMARK`

Tool to apply a text watermark to a PDF. Use when you need to annotate PDF pages with custom labels or marks; supports page selection, positioning, opacity, and rotation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Font` | string | No | Font for the text watermark (default: Helvetica). |
| `Text` | string | Yes | Text to embed as watermark. |
| `ApplyTo` | string ("All" | "Odd" | "Even" | "Specific") | No | Which pages to apply watermark to. |
| `Opacity` | number | No | Opacity of watermark text (0.0 transparent to 1.0 opaque). |
| `XIndent` | integer | No | Horizontal indent in pixels from left, overrides HorizontalAlignment. |
| `YIndent` | integer | No | Vertical indent in pixels from bottom, overrides VerticalAlignment. |
| `FilePath` | string | No | Absolute path to a local PDF file (strictly within the repository). |
| `Filename` | string | Yes | Filename of the source PDF including extension. |
| `TextSize` | integer | No | Font size in points (default: 34). |
| `TextWrap` | boolean | No | Whether to wrap watermark text. |
| `AutoScale` | boolean | No | Automatically scale text to fit the watermark area. |
| `TextLayer` | boolean | No | Add watermark on bottom layer if true. |
| `ReturnFile` | boolean | No | Return file content inline if true, else output OperationId only. |
| `TextColour` | string | No | Watermark text color as HTML code. |
| `FileContent` | object | No | The PDF file to watermark. |
| `OperationId` | string | No | Parent operation ID for advanced traceability. |
| `PageNumbers` | array | No | Pages to include when applying to Specific pages. |
| `WatermarkId` | string | No | Override the watermark identifier. |
| `ApplyAsImage` | boolean | No | Render watermark text as raster image. |
| `EncodingType` | string | No | Text encoding (default: Winansi). |
| `RotationAngle` | number | No | Rotation angle of watermark in degrees. |
| `SkipFirstPage` | boolean | No | If true, do not watermark the first page. |
| `TextAlignment` | string ("Left" | "Center" | "Right" | "Justify") | No | Alignment of text within the watermark area. |
| `TextWrapRowWidth` | integer | No | Row width for wrapping in characters. |
| `FileContentBase64` | string | No | Base64-encoded PDF content. If provided, this will be used instead of FileContent/FilePath. |
| `IgnorePageNumbers` | array | No | Pages to exclude when applying to Specific pages. |
| `VerticalAlignment` | string ("Top" | "Middle" | "Bottom") | No | Vertical alignment of watermark on the page. |
| `AutoScaleTextWidth` | integer | No | Container width in pixels when auto-scaling. |
| `AutoScaleTextHeight` | integer | No | Container height in pixels when auto-scaling. |
| `HorizontalAlignment` | string ("Left" | "Center" | "Right") | No | Horizontal alignment of watermark on the page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read QR Code from Document

**Slug:** `ENCODIAN_READ_QR_CODE_FROM_DOCUMENT`

Tool to read QR codes from PDF or DOCX documents. Returns an array of detected QR code values. Supports configuration of detection confidence, page range, and control character handling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | Document file (PDF or DOCX) to read QR codes from. |
| `endPage` | integer | No | Set the page number to end reading on. |
| `filePath` | string | No | Absolute path to a local document file. Use when a file reference is not available. Can be provided as 'filePath' (camelCase) or 'file_path' (snake_case). |
| `fileType` | string ("PDF" | "DOCX") | No | Supported source document formats for QR code reading. |
| `startPage` | integer | No | Set the page number to begin reading from. Default: 1. |
| `FileContent` | string | No | Base64-encoded file content. If provided, this will be used instead of file/file_path. |
| `barcodeReadConfidence` | string ("Low" | "Medium" | "High") | No | Confidence level for barcode detection. |
| `barcodeRemoveControlChars` | boolean | No | Set whether recognised control characters should be removed. Default: true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Word - Replace Text With Image

**Slug:** `ENCODIAN_REPLACE_TEXT_WITH_IMAGE`

Tool to replace text with an image in a Word document. Use when you need to substitute text placeholders with images; supports case-sensitive matching, whole-word matching, and replacing all occurrences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FilePath` | string | No | Absolute path to a local Word file. If provided, this will be used instead of FileContent. |
| `fileName` | string | Yes | The filename of the source Word file with extension (e.g., 'file.docx'). |
| `replaceAll` | boolean | No | Whether to replace all occurrences. |
| `searchText` | string | Yes | The text content to locate and replace with an image. |
| `FileContent` | object | No | The source Word file to process. |
| `cultureName` | string | No | Thread culture for processing the request. |
| `ImageFilePath` | string | No | Absolute path to a local image file. If provided, this will be used instead of ImageFileContent. |
| `caseSensitive` | boolean | No | Whether text matching distinguishes letter case. |
| `imageFileName` | string | Yes | The filename of the replacement image with extension (e.g., 'file.jpg'). |
| `matchWholeWord` | boolean | No | Whether to match only complete words. |
| `ImageFileContent` | object | No | The replacement image file. |
| `imageFileContent` | string | No | Base64-encoded image content. If provided, this will be used instead of ImageFileContent/ImageFilePath. |
| `FileContentBase64` | string | No | Base64-encoded Word document content. If provided, this will be used instead of FileContent/FilePath. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Email Address

**Slug:** `ENCODIAN_VALIDATE_EMAIL_ADDRESS`

Validates an email address string against a custom regex pattern using Encodian's validation API. Use this when you need to check if an email address matches a specific format or pattern. The regex parameter allows you to define custom validation rules beyond standard email format. Returns a boolean result indicating whether the email matches the pattern.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `regex` | string | Yes | The regular expression pattern to validate the email address |
| `emailAddress` | string | Yes | The email address string to validate against the regex pattern |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate URL Availability

**Slug:** `ENCODIAN_VALIDATE_URL_AVAILABILITY`

Tool to validate the availability of a specified URL. Use when needing to confirm if a web address is reachable before processing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL to verify. Include https:// or http:// in the request. |
| `validateURL` | boolean | No | Whether to validate URL syntax before checking availability. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Write Range to Excel

**Slug:** `ENCODIAN_WRITE_RANGE`

Tool to write values to a cell range in an Excel worksheet. Use when you need to programmatically update worksheet data by specifying a range and a 2D array of values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | The Excel (.xlsx) file to update. |
| `range` | string | Yes | Cell range to write values to (e.g., 'A1:B2'). |
| `values` | array | Yes | 2D array of values to write into the specified cell range. |
| `filePath` | string | No | Absolute path to a local Excel file. Use when a file reference is not available. |
| `worksheetName` | string | No | Name of the worksheet to write to. If omitted, the first worksheet is used. |
| `outputFilename` | string | No | Filename for the output Excel file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |