Skip to main content
Encodian logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 69
  • Triggers: 0
  • Slug: ENCODIAN
  • Version: 20261101_00

Tools

Slug: ENCODIAN_ADD_ATTACHMENTS_TO_PDFTool 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

object
required
The source PDF file to which attachments will be added.
array
required
Array of files to be attached to the PDF.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_ADD_IMAGE_WATERMARKTool 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

number
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7
string
required
The filename of the source PDF file, the file extension is mandatory: ‘file.pdf’ and not ‘file’
boolean
Assure that the image provided is aligned to the EXIF orientation tags
string ("Vertical" | "Horizontal" | "Diagonal")
Orientation of the watermark image.
object
The PDF file to watermark.
string
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
integer
Override and manually set an identifier for the applied watermark
boolean
Set whether to skip applying the watermark to the first page.
boolean
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
string
Base64-encoded PDF content. If provided, this will be used instead of fileContent.
string
required
The filename for the watermark image file, the file extension is mandatory: ‘file.jpg’ and not ‘file’
object
The watermark image file to apply.
string
Base64-encoded watermark image content. If provided, this will be used instead of watermarkFileContent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_ADD_IMAGE_WATERMARK_ADVANCEDTool 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

number
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%.
string ("FirstPage" | "AllPages" | "LastPage" | "Specific")
Page selection options for watermark application.
number
The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 0.7
integer
Set the quality of the image watermark from 1 to 100.
string
required
The filename of the source PDF file, the file extension is mandatory: ‘file.pdf’ and not ‘file’.
boolean
Assure that the image provided is aligned to the EXIF orientation tags.
object
required
The PDF file to watermark.
string
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
array
Specify the page numbers where the watermark should be applied, this only applies when the ‘Apply To’ property is set to ‘Specific’.
integer
Override and manually set an identifier for the applied watermark.
number
Set the X offset for positioning the watermark image on the page.
number
Set the Y offset for positioning the watermark image on the page.
number
Set the rotation angle of the image watermark in degrees.
boolean
Set whether to skip applying the watermark to the first page.
boolean
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
boolean
If set to ‘true’ the watermark image will be added to the background of the page.
array
Specify the page numbers where the watermark should not applied, this property only applies when the ‘Apply To’ property is set to ‘Specific’.
string
required
The filename for the watermark image file, the file extension is mandatory: ‘file.jpg’ and not ‘file’.
object
required
The watermark image file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_ADD_ITEMS_TO_ARRAYTool 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

string
required
The JSON array or object to modify. Provide as a JSON string.
string
Select a specific node within the ‘Data’ using a JSONPath expression.
string
required
The items to add to the ‘Data’ provided. Provide as a JSON string.
integer
Index of where to add the items. This is only applicable when the ‘Item Position’ property is set to ‘Specific’.
string ("First" | "Last" | "Specific")
Set whether to add items at the first position, last position, or a specific index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_ADD_TO_ZIPTool 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

string
Optional password to protect and encrypt the ZIP archive.
string ("UTF8" | "UTF7" | "UTF32" | "ASCII" | "Unicode" | "BigEndianUnicode")
Encoding type options for the ZIP archive.
array
required
Array of documents to be added to the ZIP archive. Each document must have fileContent (base64) and fileName.
string ("ZipCrypto" | "AES128" | "AES256")
Encryption level options for password-protected ZIP archives.
boolean
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
string
required
The filename of the output ZIP archive (including .zip extension).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_APPLY_AI_OCR_PDF_DOCUMENTTool 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

boolean
Detect the skew angle and rotate to remove that skew.
boolean
Automatically detect orientation and rotate so that text is upright.
boolean
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.
boolean
Automatically detect and remove speckles from the document.
object
required
The PDF file to process with AI OCR.
boolean
Locate and remove border pixels from the document.
boolean
Perform a 3x3 Average filter smoothing operation on the document.
boolean
Fill in isolated bumps and pits on the edges of pixel groups. Works only on bitonal documents.
boolean
Smooth the image by changing pixels of similar color values to a central color value.
boolean
Detect and remove hole punch marks from a bitonal document.
boolean
Remove shaded regions from bitonal documents.
boolean
Smooth background colors to eliminate or de-emphasize noise. Works only on color and grayscale documents.
integer
required
Minimum confidence percentage (0 to 100) used to control whether rotation is applied. Default is 60.
boolean
Automatically adjust brightness and contrast based on document analysis.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_APPLY_OCR_PDF_DOCUMENTTool 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

boolean
Detects the skew angle and rotates to remove that skew.
string ("Quality" | "Fast")
OCR processing types supported by Encodian.
boolean
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.
string
required
The filename of the source PDF file. The file extension is mandatory (e.g., ‘file.pdf’ not ‘file’).
boolean
Automatically detects speckles and removes them.
boolean
Automatically detects orientation and rotates it so that the text on it is upright oriented.
object
required
The PDF file to process with OCR.
string ("Default" | "None" | "Specific")
Document cleanup operation types.
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")
Languages supported by Encodian OCR.
string
Advanced - Set the identifier of a previous Encodian operation for operation chaining.
boolean
Locates border pixels and removes the pixels from the document, this is disabled by default.
boolean
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.
boolean
Advanced - Return the processed file (File Contents) as opposed to just an Operation ID. Set to true to receive file content in response.
boolean
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.
boolean
Set PDF/A Compliance option. If true, the output will comply with the specified PDF/A standard.
boolean
Detects and removes hole punch marks from a bitonal document.
boolean
Set whether blank pages should be removed from the PDF document.
boolean
This action will remove shaded regions from bitonal documents.
boolean
This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise.
boolean
Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window.
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")
PDF/A compliance levels supported by Encodian.
boolean
This action analyzes a document and automatically adjusts brightness and contrast based on the analysis.
integer
required
Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied. The default value is 60.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_BASE64_DECODETool 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

string
required
Desired output filename including extension (e.g., ‘output.pdf’).
string
required
The Base64-encoded content to decode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_BASE64_ENCODETool to encode a string to Base64. Use when you need to convert text into Base64 representation for use in other operations.

Input Parameters

string
required
The string to encode to Base64.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CALCULATE_DATETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CHECK_ARRAY_CONTAINS_VALUETool 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

string
required
The JSON data to evaluate (JSON array as string).
string
Select a specific node within the ‘Data’ using a JSONPath expression.
string
required
The value to check is contained within the array.
boolean
Set whether text case should be ignored when searching the array.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CHECK_TEXT_CONTAINS_VALUETool 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

string
required
The text to validate
string
required
The value to check is contained within the ‘text’ value
boolean
Set whether text case should be ignored when validating the ‘text’ value
string
Change the thread culture used to process the request
string ("CurrentCulture" | "InvariantCulture" | "Ordinal")
Specifies the rules to be used when processing the text values provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CLEAN_STRINGTool 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

string
required
The text value to process
boolean
Set whether white-space should be trimmed from the processed text value
string
Set the collection of characters to remove from the text value provided
boolean
Set whether to remove control characters from the text value
boolean
Set whether to remove characters that are invalid in file names from the text value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CLEAN_UP_IMAGE_PHOTOTool 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

boolean
Blurs the current image by averaging each pixel with its neighboring pixels giving an ‘out of focus’ appearance.
boolean
Detects the skew angle and rotates to remove that skew. Enabled by default.
boolean
Diffuses the current image by replacing each pixel with a randomly selected neighboring pixel.
boolean
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.
boolean
Adjusts the contrast in the current image.
string
required
The filename of the source image file, the file extension is mandatory: ‘file.png’ and not ‘file’.
boolean
Automatically detects speckles and removes them. Enabled by default.
boolean
Automatically detects orientation and rotates so that the text is upright oriented. Enabled by default.
object
required
The source image file to clean up.
string ("Default" | "None" | "Specific")
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.
boolean
Restores and balances the color quality within an image. Enabled by default.
boolean
Locates border pixels and removes them from the document. Disabled by default.
boolean
Automatically reduces the red reflection of the flash seen in the eyes of people in color flash photos.
boolean
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.
integer
Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied. Default is 40.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_COMBINE_ARRAYSTool 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

string
required
The JSON array or object to evaluate
string
Select a specific node within the ‘Data’ using a JSONPath expression
string
required
The key attribute to be used when combining ‘Data’ to ‘Merge Data’
string
required
The JSON array or object to evaluate and combine into ‘Data’
string
The key attribute to be used when combining ‘Merge Data’ to ‘Data’. If not provided, the ‘Data Key’ value will be used
string
Specify the fields to be combined as a comma-delimited list, for example: Forename, Age (If not supplied, all fields will be merged)
string
Select a specific node within the ‘Merge Data’ using a JSONPath expression

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_COMPARE_TEXTTool 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

boolean
Whether to ignore case when comparing the text values.
string
required
The first text value to compare.
string
required
The second text value to compare.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_COMPARE_WORD_DOCUMENTSTool 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

string
Set the name of the author used to denote differences in the output document.
boolean
Specifies whether to compare differences in fields.
boolean
Specifies whether to compare the differences in data contained in tables.
string
required
The file content of the first Microsoft Word or PDF file to compare, encoded as base64 string.
string
required
The file content of the second Microsoft Word or PDF file to compare, encoded as base64 string.
boolean
Specifies whether to compare differences in comments.
boolean
Specifies whether to compare differences in documents as case insensitive.
boolean
Specifies whether to compare differences in footnotes and endnotes.
boolean
Specifies whether to compare differences in the data contained within text boxes.
boolean
Specifies whether to ignore document formatting differences.
boolean
Specifies whether to compare differences in the data contained within headers and footers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_COMPRESS_IMAGETool 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

string
required
Filename of the source image including extension, e.g., ‘image.png’.
string ("JPG" | "PNG")
required
Image file format to compress.
object
required
The source image file to compress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_COMPRESS_PDFTool 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

object
required
The source PDF file to compress.
integer
Sets the quality for compressed images: 1 > 100
boolean
If ‘Compress Images’ and ‘Resize Images’ are enabled, images will be resized where the image resolution is greater than the specified ‘Max Resolution’ property.
boolean
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.
boolean
Flatten all fields contained within the PDF document (AcroForms only).
integer
Specifies the maximum resolution of images (dpi), if the image has a higher resolution it will be scaled dynamically.
boolean
Contained images will be compressed, aligned to the value of the ‘Image Quality’ property.
boolean
Delete all annotations contained within the PDF document.
boolean
Remove private information from the PDF document, i.e. page piece information.
boolean
Flatten all annotations contained within the PDF document.
boolean
Remove all unused objects (i.e. objects which do not have a reference) are removed from PDF document.
boolean
Remove all unused resources from the PDF document.
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).
boolean
Page contents will be reused when the PDF document is optimized for equal pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONCATENATE_TEXTConcatenate text values with an optional delimiter. The result is trimmed by default; trimming can be disabled.

Input Parameters

array
required
The array of text values to concatenate
string
The delimiter to place between the concatenated text values
boolean
Set whether white-space should be trimmed from the processed text value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_ARRAY_TO_JSONTool 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

string
required
An array or a JSON object to select an array for conversion to a named JSON object
string
required
The JSON node name to contain the array provided or selected
string
Select a specific array within the ‘data’ using a JSONPath expression

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_ARRAY_TO_XMLTool 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

string
required
An array or a JSON object to select an array for conversion to a XML object
string
required
The name of the item node XML for each array item
string
Select a specific array within the ‘Data’ using a JSONPath expression
string
required
The name of the root XML node

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_FILE_TO_PDFTool 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

string
required
The filename of the source file with extension (e.g., ‘document.docx’, ‘spreadsheet.xlsx’). The file extension is mandatory.
string
Change the thread culture used to process the request (e.g., ‘en-US’, ‘fr-FR’).
object
required
The file to convert to PDF.
boolean
Return the processed file content as opposed to just an Operation ID. Set to true to get the file content in the response.
string
required
The filename of the output PDF document (e.g., ‘output.pdf’).
boolean
Set PDF/A Compliance option. If true, the output will comply with the specified PDF/A standard.
boolean
Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF.
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")
PDF/A compliance levels supported by Encodian.
boolean
Set MS Office document comments and tracked changes removal option.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_HTML_TO_IMAGETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_HTML_TO_PDF_V2Tool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_HTML_TO_WORDTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_IMAGE_TO_GRAYSCALETool 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

string
required
The file content of the source image file, base64-encoded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_IMAGE_TO_PDFTool 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

string ("None" | "AI" | "Standard")
Set the type of OCR to be applied: None (no OCR), Standard (traditional OCR), or AI (AI-powered OCR).
object
required
The image file to convert.
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")
Set the language to use for OCR processing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_JSON_TO_EXCELTool to convert JSON data to Excel format. Use when you need to transform JSON arrays into Excel spreadsheets with customizable formatting options.

Input Parameters

integer
The first row to be written to (0-indexed).
integer
The first column to be written to (0-indexed).
string
The JSON data to be converted to an Excel document. Must be a valid JSON string representing an array of objects.
string
Change the thread culture used to process the request.
string
Base64-encoded content of a source JSON file. Use this instead of jsonData if you have a JSON file.
boolean
Ignore JSON properties which contain null values.
boolean
Set the title to bold.
string
The name of the worksheet that the JSON data is added to.
string
The filename of the output Excel document.
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")
Enum for title font color options.
boolean
Set whether a title’s text is wrapped.
boolean
Auto parse numeric and date values, setting the cell format category to ‘Number’ or ‘Date’.
boolean
Ignores titles of JSON attributes when converting JSON to Excel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_JSON_TO_XMLTool 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

string
required
The JSON to convert to XML. Must be a valid JSON string.
string
Set the name of the ‘Root’ XML element. If not provided, a default root element will be used.
boolean
Set whether to include an array attribute for collections in the XML output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_TIME_ZONE_ENCTool 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

string
required
The date and time value to convert in ISO 8601 format (e.g., ‘2024-02-14T12:00:00Z’)
string
Optional culture name to change the thread culture used to process the request (e.g., ‘en-US’, ‘fr-FR’)
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")
required
The target time zone to convert the date value to
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")
The current time zone of the date value. Defaults to ‘Default’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CONVERT_XML_TO_JSONTool 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

string
required
The XML string to convert to JSON format.
boolean
Set whether the root object should be omitted in the resulting JSON.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_COUNT_ARRAY_ITEMSTool 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

string
required
The JSON array or object to evaluate. Must be a valid JSON string.
string
Select a specific node using a JSONPath expression to count items at that path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_CREATE_QR_CODETool 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

integer
QR code width in pixels. Defaults to 88.
integer
QR code height in pixels. Defaults to 88.
string ("None" | "Nearest" | "Fixed" | "Interpolation")
QR code size mode options.
string
Background color in HTML hex format. Defaults to #FFFFFF (white).
string
Foreground color in HTML hex format. Defaults to #000000 (black).
string ("Auto" | "Bytes" | "ECIEncoding" | "ExtendedCodetext" | "Utf16BEBOM" | "Utf8BOM")
QR code encoding mode.
string ("Auto" | "ForceMicroQR" | "ForceQR")
QR code type encoding options.
integer
Image resolution in DPI (dots per inch). Defaults to 96.
string
required
The string value used to generate the QR barcode.
string
Border color in HTML hex format. Defaults to #000000 (black).
string ("Dash" | "DashDot" | "DashDotDot" | "Dot" | "Solid")
Border style options for QR code.
integer
Border width in pixels. Defaults to 2.
boolean
Whether to display a border around the QR code. Defaults to true.
string
Font name for caption above.
string
Text to display above the QR code.
string
Font name for caption below.
string
Text to display below the QR code.
string ("Default" | "Latin1" | "BigEndianUnicode" | "UTF16" | "UTF8" | "UTF7" | "ASCII")
Text encoding options for QR code data.
string
Caption above text color in HTML hex format.
string
Caption below text color in HTML hex format.
string ("PNG" | "JPG" | "SVG" | "BMP" | "TIFF" | "GIF")
required
Output image format for the QR code.
boolean
Prevent text wrapping for caption above.
boolean
Prevent text wrapping for caption below.
integer
Font size for caption above in points.
integer
Font size for caption below in points.
string ("Left" | "Center" | "Right")
Caption text alignment options.
string ("Left" | "Center" | "Right")
Caption text alignment options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_FORMAT_TEXT_CASETool 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

string
required
The text value to format.
string ("ToUpper" | "ToLower" | "ToUpperInvariant" | "ToLowerInvariant" | "ToTitleCase" | "ToSentenceCase" | "ToggleCase")
required
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).
string
Change the thread culture used to process the request. Optional parameter to specify culture-specific formatting rules (e.g., ‘en-US’, ‘fr-FR’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GENERAL_HASHTool 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

string ("Upper" | "Lower")
Character casing for the output hash: Upper | Lower.
string
required
The input to hash. For DataType=FILE, this should be a base64-encoded file content.
string ("Text" | "HEX" | "BASE64" | "FILE")
required
Format of the input data: Text | HEX | BASE64 | FILE.
string ("Text" | "HEX" | "BASE64")
required
Output format of the hash: Text | HEX | BASE64.
string
Character encoding used to process the data (e.g., ‘utf-8’).
string ("SHA1" | "SHA256" | "SHA384" | "SHA512" | "MD5")
required
Hash algorithm to use: SHA1 | SHA256 | SHA384 | SHA512 | MD5.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GENERAL_UNZIP_FILEExtracts 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

object
required
The archive file to unzip.
string
Password for encrypted archives, if required.
boolean
Whether to extract files from subfolders within the archive. If False, only root-level files are extracted. Defaults to True if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_CONVERT_EXCEL_SCHEMATool 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

string
The output format to obtain the dynamic schema for. Valid values include: PDF, HTML, CSV, TXT, XLSX, XLS, XLTX, PNG, TIFF, XLSB, XLSM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_CONVERT_WORD_SCHEMATool 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

string
The output format to obtain the dynamic schema for. Supported formats: PDF, DOCX, DOC, DOTX, RTF, HTML, TXT, PNG, TIFF, DOCM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_CADTool 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

string
The output format to obtain the dynamic schema for (e.g., PDF, BMP, GIF, JPG, PNG, TIFF).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_IMAGE_TO_PDFTool 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

string ("None" | "AI" | "Standard")
OCR type options for image to PDF conversion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_POWER_POINTTool 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

string
The output format to obtain the dynamic schema for (e.g., ‘pdf’, ‘html’, ‘png’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_CONVERT_VISIOTool 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

string ("pdf" | "bmp" | "gif" | "html" | "jpg" | "png" | "svg" | "tiff" | "vsdx")
Output format options for Visio conversion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_CREATE_BARCODETool 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

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")
Supported barcode types for schema retrieval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_CROP_IMAGETool 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

string ("Border" | "Rectangle")
Enum for supported crop types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_SEND_HTTP_REQUESTTool 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

string
The Authentication Type to obtain the dynamic schema for. Common values include ‘Basic’, ‘OAuth’, ‘ApiKey’, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_DYNAMIC_SCHEMA_WORD_INSERT_TEXTTool 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

string ("Element" | "Text")
Search type for Word Insert Text schema.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_FILE_PROPERTIESRetrieve properties of a file in an Encodian Filer container using its name or path. Optionally request user-defined metadata along with the file properties.

Input Parameters

string
required
Path or name of the blob/file to inspect.
string
required
Name of the container holding the file.
boolean
Whether to include user-defined metadata in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_AI_RUN_PROMPT_TEXTTool 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

string
required
Retrieve the operation status of a AIRunPromptText operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_ENCODIAN_SEND_TO_FILERTool 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

string
Retrieve the operation status of a GetOperationStatusEncodianSendToFiler operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_EXTRACT_IMAGETool 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

string
Retrieve the operation status of an ExtractImage operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_EXTRACT_TEXT_REGIONTool 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

string
required
Retrieve the operation status of an ExtractTextRegion operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_FILE_ONLYTool to retrieve operation status for file-only operations. Use when you need to check if an asynchronous file operation has completed.

Input Parameters

string
Retrieve the operation status for a file only operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_IMAGE_EXTRACT_TEXTTool 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

string
Retrieve the operation status of an ImageExtractText operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_MULTIPLE_FILESTool 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

string
Retrieve the operation status of a MultipleFiles operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_PDF_SPLIT_BARCODETool 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

string
required
Retrieve the operation status of a PdfSplitBarcode operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_OPERATION_STATUS_SPLIT_DOCUMENTTool 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

string
Retrieve the operation status of a SplitDocument operation for the Operation ID provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_SIGN_PDF_SCHEMATool 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

string
The certificate type to obtain the dynamic schema for. Valid values: Standard, Custom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_GET_SUBSCRIPTION_STATUSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_IMAGE_RESIZETool 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

string
required
Filename of the source image including extension, e.g., ‘image.png’.
integer
Target width in pixels. Required when ImageResizeType is ‘Specific’.
object
required
The source image file to resize.
integer
Target height in pixels. Required when ImageResizeType is ‘Specific’ unless MaintainAspectRatio is true.
string ("Percentage" | "Specific")
required
Resize by Percentage or Specific dimensions.
integer
Output DPI (dots per inch). Defaults to the source image resolution if omitted.
integer
Percentage to scale the image. Required when ImageResizeType is ‘Percentage’.
boolean
If true and ImageWidth is set, height is auto-determined; provided ImageHeight is ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_MOVE_FILEMove a file between Encodian Filer containers by specifying its source and destination paths. Optionally request that an existing destination file be overwritten.

Input Parameters

boolean
If true, overwrites the destination file if it already exists.
string
required
Path of the source blob/file to move.
string
required
Path/name for the moved file in the destination container.
string
required
Name of the container holding the source file.
string
required
Name of the container where to move the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_PDF_GET_METADATAExtract metadata and properties from a PDF, including page count and, when available, dimensions, document information, dates, format, compliance flags, encryption status, text layer presence, and custom properties.

Input Parameters

object
required
PDF file to extract metadata from.
string
Original filename including extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_PDF_WATERMARKTool 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

string
Font for the text watermark (default: Helvetica).
string
required
Text to embed as watermark.
string ("All" | "Odd" | "Even" | "Specific")
Which pages to apply watermark to.
number
Opacity of watermark text (0.0 transparent to 1.0 opaque).
integer
Horizontal indent in pixels from left, overrides HorizontalAlignment.
integer
Vertical indent in pixels from bottom, overrides VerticalAlignment.
string
required
Filename of the source PDF including extension.
integer
Font size in points (default: 34).
boolean
Whether to wrap watermark text.
boolean
Automatically scale text to fit the watermark area.
boolean
Add watermark on bottom layer if true.
boolean
Return file content inline if true, else output OperationId only.
string
Watermark text color as HTML code.
object
required
The PDF file to watermark.
string
Parent operation ID for advanced traceability.
array
Pages to include when applying to Specific pages.
string
Override the watermark identifier.
boolean
Render watermark text as raster image.
string
Text encoding (default: Winansi).
number
Rotation angle of watermark in degrees.
boolean
If true, do not watermark the first page.
string ("Left" | "Center" | "Right" | "Justify")
Alignment of text within the watermark area.
integer
Row width for wrapping in characters.
array
Pages to exclude when applying to Specific pages.
string ("Top" | "Middle" | "Bottom")
Vertical alignment of watermark on the page.
integer
Container width in pixels when auto-scaling.
integer
Container height in pixels when auto-scaling.
string ("Left" | "Center" | "Right")
Horizontal alignment of watermark on the page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_READ_QR_CODE_FROM_DOCUMENTTool 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

object
required
Document file (PDF or DOCX) to read QR codes from.
integer
Set the page number to end reading on.
string ("PDF" | "DOCX")
Supported source document formats for QR code reading.
integer
Set the page number to begin reading from. Default: 1.
string ("Low" | "Medium" | "High")
Confidence level for barcode detection.
boolean
Set whether recognised control characters should be removed. Default: true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_REPLACE_TEXT_WITH_IMAGETool 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

string
required
The filename of the source Word file with extension (e.g., ‘file.docx’).
boolean
Whether to replace all occurrences.
string
required
The text content to locate and replace with an image.
object
required
The source Word file to process.
string
Thread culture for processing the request.
boolean
Whether text matching distinguishes letter case.
string
required
The filename of the replacement image with extension (e.g., ‘file.jpg’).
boolean
Whether to match only complete words.
object
required
The replacement image file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_VALIDATE_EMAIL_ADDRESSValidates 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

string
required
The regular expression pattern to validate the email address
string
required
The email address string to validate against the regex pattern

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_VALIDATE_URL_AVAILABILITYTool to validate the availability of a specified URL. Use when needing to confirm if a web address is reachable before processing.

Input Parameters

string
required
The URL to verify. Include https:// or http:// in the request.
boolean
Whether to validate URL syntax before checking availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ENCODIAN_WRITE_RANGEWrite a 2D array of values to an Excel worksheet in an uploaded workbook and return the updated workbook content. The range supplies the starting cell; its ending cell is not used to limit the values written.

Input Parameters

object
required
The Excel (.xlsx) file to update.
string
required
Cell range to write values to (e.g., ‘A1:B2’).
array
required
2D array of values to write into the specified cell range.
string
Name of the worksheet to write to. If omitted, the first worksheet is used.
string
Filename for the output Excel file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not