# 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
- **Tools:** 71
- **Triggers:** 0
- **Slug:** `ENCODIAN`
- **Version:** 20260217_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.

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

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

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

### Add Text Watermark to PDF

**Slug:** `ENCODIAN_ADD_PDF_TEXT_WATERMARK`

Tool to add a text watermark to a PDF document with customizable font, color, size, opacity, orientation, and alignment. Use when you need to annotate PDF documents with text overlays or watermarks for branding, identification, or security purposes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

### Convert HTML to PDF

**Slug:** `ENCODIAN_CONVERT_HTML_TO_PDF`

Tool to convert HTML content to a PDF document. Use when you need to generate PDFs from HTML strings, URLs, or HTML files with customizable page settings.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

### Get File Properties

**Slug:** `ENCODIAN_GET_FILE_PROPERTIES`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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