Share via

Encodian - General

A collection of features covering AI, Archives (ZIP), Email + more

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Encodian Support
URL https://support.encodian.com
Email support@encodian.com
Connector Metadata
Publisher Encodian
Website https://www.encodian.com
Privacy policy https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy
Categories Content and Files;Collaboration

Encodian 'Flowr' General for Power Automate

The 'Encodian Flowr General' connector provides a collection of enterprise grade and simple to use Power Automate actions covering email data extraction, AI (Translation, Classification + more), archive creation and data extraction, + lots more

The Encodian 'Flowr' General connector is supported by Power Automate, Azure Logic Apps and Power Apps.

Register Account

An Encodian subscription is required to use the Encodian 'Flowr' General connector.

Complete the sign-up form to register for a 30-day trial and obtain an API Key

Click here for a step by step guide on how to create an Encodian connection in Power Automate

Support

Contact Encodian Support to request assistance

Encodian action documentation can be found here, and example flows can be found here

Further Information

Visit Encodian website for subscription plan pricing.

Once your 30-day trial expires, your Encodian subscription is automatically transitioned to Encodian's 'Free' subscription tier unless a paid plan has been purchased.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Shareable

Default

Applicable: All regions

Parameters for creating connection.

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
API Key securestring Get an API Key - https://www.encodian.com/apikey/ True
Region string

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

AI - Process Bank Check (US)

Process a Bank Check (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19806562595484
AI - Process Bank Statement (US)

Process a Bank Statement (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19807728511516
AI - Process Contract

Process a contract and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18583890798620
AI - Process Credit Card

Process a Credit Card and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19807871170460
AI - Process Health Insurance Card (US)

Process a Health Insurance Card and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18584148204956
AI - Process ID Document

Process an ID Document and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18583935825308
AI - Process Invoice

Process an invoice and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18583998185116
AI - Process Marriage Certificate (US)

Process a Marriage Certificate (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19807935722524
AI - Process Mortgage Document (US)

Process a Mortgage document (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19808100431004
AI - Process Pay Stub (US)

Process a Pay Stub (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19808015461916
AI - Process Receipt

Process a receipt and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18584183726876
AI - Process Tax Document (US)

Process a Tax Document (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19808162127644
AI - Speech to Text

Converts the speech from an audio file to text - https://support.encodian.com/hc/en-gb/articles/15851898717340
AI - Translate File

Translate the file provided into the designated language - https://support.encodian.com/hc/en-gb/articles/13790274285724
AI - Translate Text (Multiple)

Translate the text provided into multiple designated languages - https://support.encodian.com/hc/en-gb/articles/13670267593628
AI - Translate Text (Single)

Translate the text provided into a single designated language - https://support.encodian.com/hc/en-gb/articles/13568846675996
AI – Run Prompt (Text)

Run the prompt provided with the selected Open AI Model - https://support.encodian.com/hc/en-gb/articles/19106024843932
Archive (ZIP) - Create

Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP
Archive (ZIP) - Extract

Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/11853992723484
Archive (ZIP) - Extract (V2)

Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/21005901841564
Email - Extract Attachments

Extract attachments from the email provided and return an array of files - https://support.encodian.com/hc/en-gb/articles/10531671561629
Email - Extract Metadata

Extract detailed information about the email provided (Email Format, Sender, Priority + more) - https://support.encodian.com/hc/en-gb/articles/12237799140252
File - Replace Text with Image

Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874
File - Search and Replace Text

Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text
Subscription - Buy Additional Credits

Purchase the specified amount of additional credits for the current Encodian subscription - https://support.encodian.com/hc/en-gb/articles/15983208616988
Subscription – Flowr and Vertr Status

Get the the status of your Flowr / Vertr Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/360010176717-Get-Subscription-Status

AI - Process Bank Check (US)

Operation ID:
General_AIProcessBankCheckUS

Process a Bank Check (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19806562595484

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Bank Statement (US)

Operation ID:
General_AIProcessBankStatementUS

Process a Bank Statement (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19807728511516

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Contract

Operation ID:
General_AIProcessContract

Process a contract and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18583890798620

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Credit Card

Operation ID:
General_AIProcessCreditCard

Process a Credit Card and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19807871170460

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Health Insurance Card (US)

Operation ID:
General_AIProcessHealthInsuranceCardUS

Process a Health Insurance Card and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18584148204956

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process ID Document

Operation ID:
General_AIProcessIDDocument

Process an ID Document and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18583935825308

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Invoice

Operation ID:
General_AIProcessInvoice

Process an invoice and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18583998185116

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Marriage Certificate (US)

Operation ID:
General_AIProcessMarriageCertificateUS

Process a Marriage Certificate (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19807935722524

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Mortgage Document (US)

Operation ID:
General_AIProcessMortgageUS

Process a Mortgage document (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19808100431004

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Mortgage AI Model
 processFileMortgageModel string

Select the preferred mortgage model
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Pay Stub (US)

Operation ID:
General_AIProcessPayStubUS

Process a Pay Stub (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19808015461916

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Receipt

Operation ID:
General_AIProcessReceipt

Process a receipt and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/18584183726876

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Process Tax Document (US)

Operation ID:
General_AIProcessTaxUS

Process a Tax Document (US) and extract data as a JSON object - https://support.encodian.com/hc/en-gb/articles/19808162127644

Parameters

Name Key Required Type Description
File Content
 fileContent byte

The file content of the source file
Tax AI Model
 processFileTaxModel string

Select the preferred tax model
Remove New Lines
 removeNewLines boolean

Remove newlines in the data returned

Returns

Body
DtoResponseAIProcessFile

AI - Speech to Text

Operation ID:
General_AISpeechToText

Converts the speech from an audio file to text - https://support.encodian.com/hc/en-gb/articles/15851898717340

Parameters

Name Key Required Type Description
File Content
 fileContent True byte

The file content of the source audio file.
Locale
 locale string

Set the expected locale of the audio data to transcribe. The default is 'en-US'.
Punctuation Mode
 punctuationMode string

Set how to handle punctuation. The default is 'DictatedAndAutomatic'.
Profanity Filter Mode
 profanityFilterMode string

Set how to handle profanity. The default is 'Masked'.
Speaker Identification
 speakerIdentification string

Set how you would like to identify speakers in the conversation
Number of Speakers
 numberOfSpeakers integer

Set the maximum number of speakers for speaker identification. Must be less than 36 and larger than or equal to 2

Returns

Body
DtoResponseAISpeechToText

AI - Translate File

Operation ID:
General_AITranslateFile

Translate the file provided into the designated language - https://support.encodian.com/hc/en-gb/articles/13790274285724

Parameters

Name Key Required Type Description
Filename
 fileName True string

The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'
File Content
 fileContent True byte

The file content of the source file
Source Language
 sourceLanguage string

The language of the source file, select 'AUTO' to automatically detect
Target Language
 targetLanguage True string

The language to convert the source file to

Returns

Body
DtoResponseAITranslateFile

AI - Translate Text (Multiple)

Operation ID:
General_AITranslateTextMultiple

Translate the text provided into multiple designated languages - https://support.encodian.com/hc/en-gb/articles/13670267593628

Parameters

Name Key Required Type Description
Text
 text True string

The text to translate
Source Language
 sourceLanguage string

The language of the source text, select 'AUTO' to automatically detect
Target Languages
 targetLanguages True array of string

The languages to convert the source 'Text' value to
Format
 format string

Set the format of the 'Text' value
Profanity Action
 profanityAction string

Define how to handle profanity detected within the 'Text' value
Profanity Replace
 profanityReplace string

Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'

Returns

Body
DtoResponseAITranslateTextMultiple

AI - Translate Text (Single)

Operation ID:
General_AITranslateText

Translate the text provided into a single designated language - https://support.encodian.com/hc/en-gb/articles/13568846675996

Parameters

Name Key Required Type Description
Text
 text True string

The text to translate
Source Language
 sourceLanguage string

The language of the source text, select 'AUTO' to automatically detect
Target Language
 targetLanguage True string

The language to convert the source 'Text' value to
Format
 format string

Set the format of the 'Text' value
Profanity Action
 profanityAction string

Define how to handle profanity detected within the 'Text' value
Profanity Replace
 profanityReplace string

Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'

Returns

Body
DtoResponseAITranslateText

AI – Run Prompt (Text)

Operation ID:
General_AIRunPromptText

Run the prompt provided with the selected Open AI Model - https://support.encodian.com/hc/en-gb/articles/19106024843932

Parameters

Name Key Required Type Description
Model
 model True string

Select the Open AI model
Prompt
 prompt True string

The prompt for processing the 'Text' value provided
Conversation
 conversation string

Optional - A JSON representation of the Open AI conversation for the associated chat session
Context
 context string

Optional - Sets context and rules for the conversation
Frequency Penalty
 frequencyPenalty float

A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text. Positive values will make tokens less likely to appear as their frequency increases and decrease the likelihood of the model repeating the same statements verbatim. Supported range is [-2, 2]
Maximum Output Tokens
 maxOutputTokens integer

Set the maximum limit for the number of tokens that can be generated for output tokens
Presence Penalty
 presencePenalty float

A value that influences the probability of generated tokens appearing based on their existing presence in generated text. Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics. Supported range is [-2, 2]
Temperature
 temperature float

The sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic. It is not recommended to modify temperature and top_p for the same completions request as the interaction of these two settings is difficult to predict. Supported range is [0, 1]

Returns

Body
DtoResponseAIRunPromptText

Archive (ZIP) - Create

Operation ID:
General_AddToZip

Add the files provided to an archive (.zip) file - https://support.encodian.com/hc/en-gb/articles/360002674918-Add-to-Archive-ZIP

Parameters

Name Key Required Type Description
Filename
 outputFilename True string

The filename of the output ZIP package
Filename
 fileName string

The filename of the file
File Content
 fileContent byte

The file content of the file
Folder Path
 folderPath string

The folder path to place this file within
Password
 Password string

Set a password to protect and encrypt the archive (ZIP file)
Encryption
 encryption string

Set the encryption level which will be applied to a password protected archive (ZIP file)
Encoding
 encoding string

Set the encoding type.

Returns

Body
DtoResponseZipArrayOfDocuments

Archive (ZIP) - Extract

Operation ID:
General_ExtractFromArchive

Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/11853992723484

Parameters

Name Key Required Type Description
File Content
 fileContent True byte

The file content of the archive
Password
 password string

Set a password for opening the archive
Recursive
 includeFolders True boolean

Set whether to extract files contained within sub folders which are present in the archive

Returns

Body
DtoResponseExtractFromArchive

Archive (ZIP) - Extract (V2)

Operation ID:
General_ExtractFromArchiveV2

Extract files from the archive provided (ZIP, GZip, RAR, TAR, 7Zip + more) - https://support.encodian.com/hc/en-gb/articles/21005901841564

Parameters

Name Key Required Type Description
File Content
 fileContent True byte

The file content of the archive
Password
 password string

Set a password for opening the archive
Recursive
 recursive True boolean

Set whether to extract files contained within sub folders which are present in the archive

Returns

Body
DtoResponseExtractFromArchiveV2

Email - Extract Attachments

Operation ID:
General_GetEmailAttachments

Extract attachments from the email provided and return an array of files - https://support.encodian.com/hc/en-gb/articles/10531671561629

Parameters

Name Key Required Type Description
Filename
 fileName True string

The filename of the source email file, the file extension is mandatory: 'file.eml' or 'file.msg' and not 'file'
File Content
 fileContent True byte

The file content of the email
Get Inline Attachments
 getInlineAttachments True boolean

Set whether to extract inline attachments

Returns

Body
DtoResponseGetEmailAttachments

Email - Extract Metadata

Operation ID:
General_GetEmailInfo

Extract detailed information about the email provided (Email Format, Sender, Priority + more) - https://support.encodian.com/hc/en-gb/articles/12237799140252

Parameters

Name Key Required Type Description
File Content
 fileContent True byte

The file content of the email
Culture Name
 cultureName string

Change the thread culture used to process the request.

Returns

Body
DtoResponseGetEmailInfo

File - Replace Text with Image

Operation ID:
General_SearchAndReplaceTextWithImage

Find and replace text contained within a PDF or DOCX document with an image - https://support.encodian.com/hc/en-gb/articles/360027234874

Parameters

Name Key Required Type Description
File Type
 fileType string

Select the source document format.
Filename
 FileName string

The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'
File Content
 FileContent byte

The file content of the source file
Search Text
 SearchText True string

The text to locate and replace with the specified image
Image Filename
 imageFilename True string

The filename for the image file, the file extension is mandatory: 'file.jpg' and not 'file'
Image File Content
 imageFileContent True byte

The content of the image file
Skip First Page
 skipFirstPage boolean

Set whether to ignore the first page when searching for the text fragment.
Apply To
 applyTo string

Set which pages within the document to search for the text fragment
Page Numbers
 pageNumbers array of integer

Specify the page numbers to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'.
Ignore Page Numbers
 ignorePageNumbers array of integer

Specify the page numbers not to search for the text fragment, this property only applies when the 'Apply To' property is set to 'Specific'.
Operation ID
 operationId 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
Return File
 FinalOperation 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

Returns

Body
DtoResponseSearchAndReplaceTextWithImage

File - Search and Replace Text

Operation ID:
General_SearchAndReplaceText

Find and replace text contained within a PDF or DOCX document - https://support.encodian.com/hc/en-gb/articles/360020937853-Search-and-Replace-Text

Parameters

Name Key Required Type Description
File Type
 fileType string

Select the source document format.
Filename
 FileName string

The filename of the source file, the file extension is mandatory: 'file.pdf' and not 'file'
File Content
 FileContent byte

The file content of the source file
Search Text
 SearchText True string

Optional - The text to locate and replace with the 'Replacement Text' value
Is Expression
 IsExpression boolean

Set whether the 'Search Text' value should be evaluted as a regular expression, the default value is 'false'
Replacement Text
 ReplacementText string

The text to replace the 'Search Text' text with
Font
 Font string

The name of the font to use for the 'Replacement Text', the default font is 'Arial'
Font Size
 FontSize integer

The size of the font to use for the 'Replacement Text', the default size is '16'
Font Colour
 FontColour string

The HTML colour of the font to use for the 'Replacement Text', the default colour is '#000000'
Background Colour
 BackgroundColour string

The background HTML colour to use for the 'Replacement Text', the default colour is '#FFFFFF'
Underline
 Underline boolean

Set whether the 'Replacement Text' should be underlined, the default value is 'false'
Word Spacing
 WordSpacing float

The word spacing to apply to the 'Replacement Text'
Line Spacing
 LineSpacing float

The line spacing to apply to the 'Replacement Text'
Operation ID
 operationId 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
Return File
 FinalOperation 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

Returns

Body
DtoResponseSearchAndReplaceText

Subscription - Buy Additional Credits

Operation ID:
General_BuyAdditionalCredits

Purchase the specified amount of additional credits for the current Encodian subscription - https://support.encodian.com/hc/en-gb/articles/15983208616988

Parameters

Name Key Required Type Description
Product Name
 productName True string

The product name of the subscription to add additional credits to
Purchase Type
 purchaseType True string

The purchase type for the order: 'Automated' or 'Invoice'
Credits
 credits True integer

The number of additional credits to be purchased: Multiples of 250 for 'Automated' orders, Multiples of 1000 for 'Invoice' orders (Minimum 4000)
Purchase Order
 purchaseOrder string

The ID of the purchase order

Returns

Body
DtoResponseBuyAdditionalCredits

Subscription – Flowr and Vertr Status

Operation ID:
General_GetSubscriptionStatus

Get the the status of your Flowr / Vertr Encodian Subscription - https://support.encodian.com/hc/en-gb/articles/360010176717-Get-Subscription-Status

Parameters

Name Key Required Type Description
body
 body

Returns

Body
DtoResponseMgmtGetSubscriptionStatus

Definitions

DocumentArray

Name Path Type Description
Filename
 fileName string

The filename of the file
File Content
 fileContent byte

The file content of the file

DtoResponseAIProcessFile

Name Path Type Description
Result
 result string

The response value for the request
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAIRunPromptText

Name Path Type Description
Message
 message string

The Open AI response message
Conversation
 conversation string

The Open AI conversation as JSON
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAISpeechToText

Name Path Type Description
Result
 result string

The response value for the request
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAITranslateFile

Name Path Type Description
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.
Filename
 Filename string

The filename of the document.
File Content
 FileContent byte

The processed document.

DtoResponseAITranslateText

Name Path Type Description
Translation
 translation string

The translated text
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseAITranslateTextMultiple

Name Path Type Description
Translations
 translations string

The translated text as JSON
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseBuyAdditionalCredits

Name Path Type Description
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseExtractFromArchive

Name Path Type Description
Documents
 documents array of DocumentArray

The array of documents extracted from the archive provided
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseExtractFromArchiveV2

Name Path Type Description
Documents
 documents array of ExtractArchiveDocumentArray

The array of documents extracted from the archive provided
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseGetEmailAttachments

Name Path Type Description
Documents
 documents array of DocumentArray

The array of documents extracted from the source Email
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseGetEmailInfo

Name Path Type Description
Subject
 subject string

The subject of the email message
Body - Text
 bodyText string

The content of the email message as text
Body - HTML
 bodyHtml string

The content of the email message as HTML
To
 to string

A comma delimited list of email addresses from the 'To' property
To - Array
 toArray array of string

An array of email addresses obtained from the 'To' property
Cc
 cc string

A comma delimited list of email addresses obtained from the 'Cc' property
Cc - Array
 ccArray array of string

An array of email addresses obtained from the 'Cc' property
Bcc
 bcc string

A comma delimited list of email addresses obtained from the 'Bcc' property
Bcc - Array
 bccArray array of string

An array of email addresses obtained from the 'Bcc' property
From
 from string

The email address obtained from the 'From' property
Sent
 sent date-time

The date and time the email message was sent
Priority
 priority string

The priority of the email message
Sensitivity
 sensitivity string

The sensitivity of the email message
Has Attachments
 hasAttachments boolean

Indicates whether the email message contains attachments
File Size (MBs)
 fileSize string

The size of the email message (MBs)
Message ID
 messageId string

The message ID of the email message
Headers
 headers array of string

An array of headers obtained from the email message
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseMgmtGetSubscriptionStatus

Name Path Type Description
Available Credits
 availableActionsMonth integer

The number of credits remaining for the current calendar month.
Available Credits - Utility Actions
 availableActionsMonthDec double

The number of utility action credits remaining for the current calendar month (as a decimal).
Subscription Enabled
 subscriptionEnabled boolean

Indicates whether the Encodian subscription is enabled or disabled.
Subscription Level
 subscriptionLevel string

Details the current Encodian subscription level.
Monthly Credits
 monthlyActions integer

Details the allowed credits per month for the current Encodian subscription level.
Expiry Date
 expiryDate date-time

The date and time your Encodian subscription will expire.
Billing Interval
 billingInterval string

Details the current billing interval (Monthly or Annually).
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.

DtoResponseSearchAndReplaceText

Name Path Type Description
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.
Filename
 Filename string

The filename of the document.
File Content
 FileContent byte

The processed document.

DtoResponseSearchAndReplaceTextWithImage

Name Path Type Description
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.
Filename
 Filename string

The filename of the document.
File Content
 FileContent byte

The processed document.

DtoResponseZipArrayOfDocuments

Name Path Type Description
HTTP Status Code
 HttpStatusCode integer

The HTTP Status code for the response.
HTTP Status Message
 HttpStatusMessage string

The HTTP Status message for the response.
Operation ID
 OperationId string

The unique ID assigned to this operation.
Errors
 Errors array of string

An array of error messages should an error occur.
Operation Status
 OperationStatus string

Indicates whether the operation has completed, has been queued or has failed.
Filename
 Filename string

The filename of the document.
File Content
 FileContent byte

The processed document.

ExtractArchiveDocumentArray

Name Path Type Description
Filename
 fileName string

The filename of the file
File Content
 fileContent byte

The file content of the file
Directory
 directory string

The directory path of the file