> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Encodian

The Encodian connector lets your AI agent act in each user's Encodian account. Each user connects their own Encodian API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Files & Documents, Automation
**Tools:** 60: 1 read, 59 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=ENCODIAN)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Encodian connection

   In **AgentKit > Connections**, create an Encodian connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'encodian'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Encodian:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'encodian_subscription_status_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "encodian"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Encodian:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="encodian_subscription_status_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Encodian credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'encodian_subscription_status_get',
  toolInput: {},
  connector: 'encodian',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="encodian_subscription_status_get",
    tool_input={},
    connection_name="encodian",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `encodian_subscription_status_get`

Get Subscription Status · Read-only

Get the Encodian Flowr subscription's status, plan, credits used and credits remaining.
Returns availableActionsMonth, availableActionsMonthDec, subscriptionEnabled, subscriptionLevel, monthlyActions, expiryDate, billingInterval, HttpStatusCode, HttpStatusMessage, OperationId.
Use this to check the API key and remaining credits.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `encodian_ai_invoice_process`

Extract Invoice Data (AI) · Write

Extract structured invoice data (vendor, totals, line items, dates) from an invoice PDF or image.
Returns result, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Use encodian_ai_receipt_process for receipts. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `date_format` (`string`, optional): Set the date format to apply to DateTime values present within the extracted data set. Formats should conform to standard Microsoft notation - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings. Example: yyyy-MM-dd
- `prebuilt_model` (`string`, optional): Set the Prebuilt Model to be used within the Azure service. Example: Contract. One of: `Contract`, `HealthInsuranceCardUS`, `IDDocument`, `Invoice`, `Receipt`, `BankCheckUs`, `BankStatementUS`, `CreditCard`, `MarriageCertificateUS`, `Mortgage1003`, `Mortgage1004`, `Mortgage1005`, `Mortgage1008`, `MortgageClosingDisclosure`, `PayStubUS`, `TaxUS`, `TaxW2`, `TaxW4`, `Tax1095A`, `Tax1095C`, `Tax1098`, `Tax1098E`, `Tax1098T`, `Tax1099A`, `Tax1099B`, `Tax1099C`, `Tax1099CAP`, `Tax1099Combo`, `Tax1099DIV`, `Tax1099G`, `Tax1099H`, `Tax1099INT`, `Tax1099K`, `Tax1099LS`, `Tax1099LTC`, `Tax1099MISC`, `Tax1099NEC`, `Tax1099OID`, `Tax1099PATR`, `Tax1099Q`, `Tax1099QA`, `Tax1099R`, `Tax1099S`, `Tax1099SA`, `Tax1099SB`, `Tax1099SSA`, `Tax1040`, `Tax1040Schedule1`, `Tax1040Schedule2`, `Tax1040Schedule3`, `Tax1040Schedule8812`, `Tax1040ScheduleA`, `Tax1040ScheduleB`, `Tax1040ScheduleC`, `Tax1040ScheduleD`, `Tax1040ScheduleE`, `Tax1040ScheduleEIC`, `Tax1040ScheduleF`, `Tax1040ScheduleH`, `Tax1040ScheduleJ`, `Tax1040ScheduleR`, `Tax1040ScheduleSE`, `Tax1040Senior`.
- `query_fields` (`string`, optional): A comma separated list of query fields to search for. Example: []
- `remove_new_lines` (`boolean`, optional): Remove newlines in the data returned. Example: false

Example input: `{"file_content":"<file_content>"}`

### `encodian_ai_prompt_run`

Run AI Prompt · Write

Run a prompt against an AI model through Encodian and return the response text.
Returns message, conversation, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Use for summarising or rewriting text inside a document workflow. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `model` (`string`, required): Select the Open AI model. One of: GPT_4_1, GPT_4_1_mini, o4_mini, GPT_5_4. Example: GPT_4_1_mini. One of: `GPT_4_1`, `GPT_4_1_mini`, `o4_mini`, `GPT_5_4`.
- `prompt` (`string`, required): The prompt for processing the 'Text' value provided. Example: Summarise the following text in two sentences.
- `context` (`string`, optional): Optional - Sets context and rules for the conversation. Example: []
- `conversation` (`string`, optional): Optional - A JSON representation of the Open AI conversation for the associated chat session. Example: []
- `frequency_penalty` (`number`, optional): 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]. Example: 10
- `max_output_tokens` (`integer`, optional): Set the maximum limit for the number of tokens that can be generated for output tokens. Example: 10
- `presence_penalty` (`number`, optional): 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]. Example: 10
- `reasoning_effort` (`string`, optional): Only used for GPT 5.4; a value that controls the reasoning effort used while generating a response. Reducing reasoning effort can result in faster responses and fewer tokens used. One of: Low, Medium, High. Example: Low. One of: `Low`, `Medium`, `High`.
- `temperature` (`number`, optional): 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]. Example: 10

Example input: `{"model":"GPT_4_1","prompt":"<prompt>"}`

### `encodian_ai_receipt_process`

Extract Receipt Data (AI) · Write

Extract structured receipt data (merchant, totals, items, date) from a receipt image or PDF.
Returns result, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Use encodian_ai_invoice_process for invoices. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `date_format` (`string`, optional): Set the date format to apply to DateTime values present within the extracted data set. Formats should conform to standard Microsoft notation - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings. Example: yyyy-MM-dd
- `prebuilt_model` (`string`, optional): Set the Prebuilt Model to be used within the Azure service. Example: Contract. One of: `Contract`, `HealthInsuranceCardUS`, `IDDocument`, `Invoice`, `Receipt`, `BankCheckUs`, `BankStatementUS`, `CreditCard`, `MarriageCertificateUS`, `Mortgage1003`, `Mortgage1004`, `Mortgage1005`, `Mortgage1008`, `MortgageClosingDisclosure`, `PayStubUS`, `TaxUS`, `TaxW2`, `TaxW4`, `Tax1095A`, `Tax1095C`, `Tax1098`, `Tax1098E`, `Tax1098T`, `Tax1099A`, `Tax1099B`, `Tax1099C`, `Tax1099CAP`, `Tax1099Combo`, `Tax1099DIV`, `Tax1099G`, `Tax1099H`, `Tax1099INT`, `Tax1099K`, `Tax1099LS`, `Tax1099LTC`, `Tax1099MISC`, `Tax1099NEC`, `Tax1099OID`, `Tax1099PATR`, `Tax1099Q`, `Tax1099QA`, `Tax1099R`, `Tax1099S`, `Tax1099SA`, `Tax1099SB`, `Tax1099SSA`, `Tax1040`, `Tax1040Schedule1`, `Tax1040Schedule2`, `Tax1040Schedule3`, `Tax1040Schedule8812`, `Tax1040ScheduleA`, `Tax1040ScheduleB`, `Tax1040ScheduleC`, `Tax1040ScheduleD`, `Tax1040ScheduleE`, `Tax1040ScheduleEIC`, `Tax1040ScheduleF`, `Tax1040ScheduleH`, `Tax1040ScheduleJ`, `Tax1040ScheduleR`, `Tax1040ScheduleSE`, `Tax1040Senior`.
- `query_fields` (`string`, optional): A comma separated list of query fields to search for. Example: []
- `remove_new_lines` (`boolean`, optional): Remove newlines in the data returned. Example: false

Example input: `{"file_content":"<file_content>"}`

### `encodian_ai_text_translate`

Translate Text (AI) · Write

Translate text into another language with Encodian's AI translation.
Returns translation, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Give language codes such as en, fr or de. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `target_language` (`string`, required): The language to convert the source 'Text' value to. Example: French. One of: `Afrikaans`, `Albanian`, `Amharic`, `Arabic`, `Armenian`, `Assamese`, `AzerbaijaniLatin`, `Bangla`, `Bashkir`, `Basque`, `Bhojpuri`, `Bodo`, `BosnianLatin`, `Bulgarian`, `CantoneseTraditional`, `Catalan`, `ChineseLiterary`, `ChineseSimplified`, `ChineseTraditional`, `ChiShona`, `Croatian`, `Czech`, `Danish`, `Dari`, `Divehi`, `Dogri`, `Dutch`, `English`, `Estonian`, `Faroese`, `Fijian`, `Filipino`, `Finnish`, `French`, `FrenchCanadian`, `Galician`, `Georgian`, `German`, `Greek`, `Gujarati`, `HaitianCreole`, `Hausa`, `Hebrew`, `Hindi`, `HmongDawLatin`, `Hungarian`, `Icelandic`, `Igbo`, `Indonesian`, `Inuinnaqtun`, `Inuktitut`, `InuktitutLatin`, `Irish`, `Italian`, `Japanese`, `Kannada`, `Kashmiri`, `Kazakh`, `Khmer`, `Kinyarwanda`, `Klingon`, `KlingonPlqaD`, `Konkani`, `Korean`, `KurdishCentral`, `KurdishNorthern`, `KyrgyzCyrillic`, `Lao`, `Latvian`, `Lithuanian`, `Lingala`, `LowerSorbian`, `Luganda`, `Macedonian`, `Maithili`, `Malagasy`, `MalayLatin`, `Malayalam`, `Maltese`, `Maori`, `Marathi`, `MongolianCyrillic`, `MongolianTraditional`, `Myanmar`, `Nepali`, `Norwegian`, `Nyanja`, `Odia`, `Pashto`, `Persian`, `Polish`, `PortugueseBrazil`, `PortuguesePortugal`, `Punjabi`, `QueretaroOtomi`, `Romanian`, `Rundi`, `Russian`, `SamoanLatin`, `SerbianCyrillic`, `SerbianLatin`, `Sesotho`, `SesothoSaLeboa`, `Setswana`, `Sindhi`, `Sinhala`, `Slovak`, `Slovenian`, `SomaliArabic`, `Spanish`, `SwahiliLatin`, `Swedish`, `Tahitian`, `Tamil`, `TatarLatin`, `Telugu`, `Thai`, `Tibetan`, `Tigrinya`, `Tongan`, `Turkish`, `TurkmenLatin`, `Ukrainian`, `UpperSorbian`, `Urdu`, `UyghurArabic`, `UzbekLatin`, `Vietnamese`, `Welsh`, `Xhosa`, `Yoruba`, `YucatecMaya`, `Zulu`.
- `text` (`string`, required): The text to translate. Example: Contact sales@acme.com or visit https://acme.com for details.
- `format` (`string`, optional): Set the format of the 'Text' value. One of: HTML, Text. Example: Text. One of: `HTML`, `Text`.
- `profanity_action` (`string`, optional): Define how to handle profanity detected within the 'Text' value. One of: Delete, Keep, Replace. Example: Keep. One of: `Delete`, `Keep`, `Replace`.
- `profanity_replace` (`string`, optional): Set the value used to replace profanity detected within the 'Text' value. This setting only applies when the 'Profanity Action' is set to 'Replace'. One of: Asterisk, Tag. Example: Asterisk. One of: `Asterisk`, `Tag`.
- `source_language` (`string`, optional): The language of the source text, select 'AUTO' to automatically detect. Example: English. One of: `AUTO`, `Afrikaans`, `Albanian`, `Amharic`, `Arabic`, `Armenian`, `Assamese`, `AzerbaijaniLatin`, `Bangla`, `Bashkir`, `Basque`, `Bhojpuri`, `Bodo`, `BosnianLatin`, `Bulgarian`, `CantoneseTraditional`, `Catalan`, `ChineseLiterary`, `ChineseSimplified`, `ChineseTraditional`, `ChiShona`, `Croatian`, `Czech`, `Danish`, `Dari`, `Divehi`, `Dogri`, `Dutch`, `English`, `Estonian`, `Faroese`, `Fijian`, `Filipino`, `Finnish`, `French`, `FrenchCanadian`, `Galician`, `Georgian`, `German`, `Greek`, `Gujarati`, `HaitianCreole`, `Hausa`, `Hebrew`, `Hindi`, `HmongDawLatin`, `Hungarian`, `Icelandic`, `Igbo`, `Indonesian`, `Inuinnaqtun`, `Inuktitut`, `InuktitutLatin`, `Irish`, `Italian`, `Japanese`, `Kannada`, `Kashmiri`, `Kazakh`, `Khmer`, `Kinyarwanda`, `Klingon`, `KlingonPlqaD`, `Konkani`, `Korean`, `KurdishCentral`, `KurdishNorthern`, `KyrgyzCyrillic`, `Lao`, `Latvian`, `Lithuanian`, `Lingala`, `LowerSorbian`, `Luganda`, `Macedonian`, `Maithili`, `Malagasy`, `MalayLatin`, `Malayalam`, `Maltese`, `Maori`, `Marathi`, `MongolianCyrillic`, `MongolianTraditional`, `Myanmar`, `Nepali`, `Norwegian`, `Nyanja`, `Odia`, `Pashto`, `Persian`, `Polish`, `PortugueseBrazil`, `PortuguesePortugal`, `Punjabi`, `QueretaroOtomi`, `Romanian`, `Rundi`, `Russian`, `SamoanLatin`, `SerbianCyrillic`, `SerbianLatin`, `Sesotho`, `SesothoSaLeboa`, `Setswana`, `Sindhi`, `Sinhala`, `Slovak`, `Slovenian`, `SomaliArabic`, `Spanish`, `SwahiliLatin`, `Swedish`, `Tahitian`, `Tamil`, `TatarLatin`, `Telugu`, `Thai`, `Tibetan`, `Tigrinya`, `Tongan`, `Turkish`, `TurkmenLatin`, `Ukrainian`, `UpperSorbian`, `Urdu`, `UyghurArabic`, `UzbekLatin`, `Vietnamese`, `Welsh`, `Xhosa`, `Yoruba`, `YucatecMaya`, `Zulu`.

Example input: `{"target_language":"Afrikaans","text":"<text>"}`

### `encodian_barcode_create`

Create Barcode · Write

Create a barcode image of a chosen type (Code 128, EAN-13 and others) from data.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the image as base64. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code_text_encoding` (`string`, required): Set Encoding of the text. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: UTF8. One of: `Default`, `Latin1`, `BigEndianUnicode`, `UTF16`, `UTF8`, `UTF7`, `ASCII`.
- `dot_codemask` (`integer`, required): Set the mask value for DotCode barcodes. Example: -1
- `aspect_ratio` (`number`, optional): Set the aspect ratio of the barcode. Example: 1
- `australian_post_encoding_table` (`string`, optional): Set encoding table type for an Australian Post barcode. One of: CTable, NTable, Other. Example: Other. One of: `CTable`, `NTable`, `Other`.
- `australian_post_short_bar_height` (`integer`, optional): Set short bar height for an Australian Post barcode (pixels). Example: 120
- `aztec_error_level` (`integer`, optional): Set the error level protect for Aztec barcodes (value between 10-95) Example: 10
- `aztec_symbol_mode` (`string`, optional): Set the Aztec symbol mode for Aztec barcodes. One of: Auto, Compact, FullRange, Rune. Example: Auto. One of: `Auto`, `Compact`, `FullRange`, `Rune`.
- `back_color` (`string`, optional): Set the barcode back color of the barcode. (HTML color format). Example: White
- `bar_color` (`string`, optional): Set the color of the barcode bars (HTML color format). Example: Black
- `bar_height` (`integer`, optional): Set the height of the barcode bars (pixels). Example: 10
- `barcode_caption_above_font` (`string`, optional): Set the font for the caption above the barcode. Example: example
- `barcode_caption_above_font_alignment` (`string`, optional): Set the alignment of the font applied to the caption text above the barcode. One of: Left, Centre, Right. Example: Left. One of: `Left`, `Centre`, `Right`.
- `barcode_caption_above_font_colour` (`string`, optional): Set the color of the font applied to the caption text above the barcode. Example: AliceBlue. One of: `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`.
- `barcode_caption_above_font_size` (`number`, optional): Set the size of the font applied to the caption text above the barcode. Example: 25
- `barcode_caption_above_font_style` (`string`, optional): Set the style of the font applied to the caption text above the barcode. One of: Regular, Bold, Italic, Underline, Strikeout. Example: Regular. One of: `Regular`, `Bold`, `Italic`, `Underline`, `Strikeout`.
- `barcode_caption_below_font` (`string`, optional): Set the font for the caption below the barcode. Example: example
- `barcode_caption_below_font_alignment` (`string`, optional): Set the alignment of the font applied to the caption text below the barcode. One of: Left, Centre, Right. Example: Left. One of: `Left`, `Centre`, `Right`.
- `barcode_caption_below_font_colour` (`string`, optional): Set the color of the font applied to the caption text below the barcode. Example: AliceBlue. One of: `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`.
- `barcode_caption_below_font_size` (`number`, optional): Set the size of the font applied to the caption text below the barcode. Example: 25
- `barcode_caption_below_font_style` (`string`, optional): Set the style of the font applied to the caption text below the barcode. One of: Regular, Bold, Italic, Underline, Strikeout. Example: Regular. One of: `Regular`, `Bold`, `Italic`, `Underline`, `Strikeout`.
- `barcode_data` (`string`, optional): Barcode Data. Example: https://acme.com
- `barcode_image_format` (`string`, optional): Barcode Image Format. One of: PNG, JPG, SVG, BMP, TIFF, GIF. Example: PNG. One of: `PNG`, `JPG`, `SVG`, `BMP`, `TIFF`, `GIF`.
- `barcode_type` (`string`, optional): Set the type of barcode to be produced. Example: AustraliaPost. One of: `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`.
- `barcode_type_parameter` (`string`, optional): Set the barcode type. Example: AustraliaPost. One of: `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`.
- `barcode_value_text_location` (`string`, optional): Set the location of the barcode value text. One of: None, Above, Below. Example: Below. One of: `None`, `Above`, `Below`.
- `border_color` (`string`, optional): Set the barcode border color (HTML color format) Example: Black
- `border_style` (`string`, optional): Set the barcode code border style. One of: Dash, DashDot, DashDotDot, Dot, Solid. Example: Dash. One of: `Dash`, `DashDot`, `DashDotDot`, `Dot`, `Solid`.
- `border_visible` (`boolean`, optional): Set whether the barcode border is visible or not. Example: true
- `border_width` (`integer`, optional): Set width of the barcode border (pixels). Example: 12345
- `caption_above` (`string`, optional): Set the caption text above the barcode. Example: Order 1042
- `caption_below` (`string`, optional): Set the caption text below the barcode. Example: acme.com
- `codabar_checksum_mode` (`string`, optional): Set the checksum mode for Codabar barcodes. One of: Mod10, Mod16. Example: Mod16. One of: `Mod10`, `Mod16`.
- `codabar_start_symbol` (`string`, optional): Set the start symbol for Codabar barcodes. One of: A, B, C, D. Example: A. One of: `A`, `B`, `C`, `D`.
- `codabar_stop_symbol` (`string`, optional): Set the stop symbol for Codabar barcodes. One of: A, B, C, D. Example: B. One of: `A`, `B`, `C`, `D`.
- `code16_k_quiet_zone_left_coef` (`integer`, optional): Set the size of the left quiet zone as a multiple of the xDimension for Code16K barcodes. Example: 10
- `code16_k_quiet_zone_right_coef` (`integer`, optional): Set the size of the right quiet zone as a multiple of the xDimension for Code16K barcodes. Example: 1
- `columns` (`integer`, optional): Set the number of columns. Example: 10
- `data_matrix_ecc` (`string`, optional): Set the DataMatrix ECC type for DataMatrix barcodes. One of: EccAuto, Ecc000, Ecc050, Ecc080, Ecc100, Ecc140, Ecc200. Example: EccAuto. One of: `EccAuto`, `Ecc000`, `Ecc050`, `Ecc080`, `Ecc100`, `Ecc140`, `Ecc200`.
- `data_matrix_encode_mode` (`string`, optional): Set encoding mode for DataMatrix barcodes. One of: Auto, ASCII, Bytes, C40, Text, EDIFACT, ANSIX12, ExtendedCodetext, Extended, Base256, Binary, ECI. Example: Auto. One of: `Auto`, `ASCII`, `Bytes`, `C40`, `Text`, `EDIFACT`, `ANSIX12`, `ExtendedCodetext`, `Extended`, `Base256`, `Binary`, `ECI`.
- `filled_bars` (`boolean`, optional): Set whether the barcode bars are a filled. Example: true
- `height` (`integer`, optional): Set the barcode height (pixels). Example: 10
- `itf_border_thickness` (`integer`, optional): Set the border thickness for ITF barcodes (pt). Example: 1
- `itf_border_type` (`string`, optional): Set the border type for ITF barcodes. One of: None, Frame, Bar, FrameOut, BarOut. Example: Bar. One of: `None`, `Frame`, `Bar`, `FrameOut`, `BarOut`.
- `maxi_code_encode_mode` (`integer`, optional): Set the encode mode for Maxi Code barcodes (value between 2 and 6). Example: 4
- `padding_bottom` (`integer`, optional): Set bottom padding of the barcode (pixels). Example: 10
- `padding_left` (`integer`, optional): Set left padding of the barcode (pixels). Example: 10
- `padding_right` (`integer`, optional): Set right padding of the barcode (pixels). Example: 10
- `padding_top` (`integer`, optional): Set top padding of the barcode (pixels). Example: 10
- `pdf417_compaction_mode` (`string`, optional): Set the compaction mode for Pdf417 barcodes. One of: Auto, Text, Numeric, Binary. Example: Auto. One of: `Auto`, `Text`, `Numeric`, `Binary`.
- `pdf417_error_level` (`string`, optional): Set the error level for Pdf417 barcodes. One of: Level0, Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8. Example: Level8. One of: `Level0`, `Level1`, `Level2`, `Level3`, `Level4`, `Level5`, `Level6`, `Level7`, `Level8`.
- `pdf417_macro_file_id` (`integer`, optional): Set the macro file ID for Pdf417 barcodes. Example: 1
- `pdf417_macro_segment_id` (`integer`, optional): Set the macro segment ID for Pdf417 barcodes. Example: 1
- `pdf417_macro_segments_count` (`integer`, optional): Set macro segment count for Pdf417 barcodes. Example: 1
- `pdf417_truncate` (`boolean`, optional): Set whether the Pdf417 barcode is truncated to save space. Example: false
- `postal_short_bar_height` (`integer`, optional): Set the short bar height of Postal barcodes. Example: 20
- `quiet_zone_coef` (`integer`, optional): Set the quiet zone coefficient as a mulitple of the X Dimension for ITF barcodes. Example: 10
- `resolution` (`integer`, optional): Set the barcode code border image resolution (dpi) Example: 10
- `rotationangle` (`number`, optional): Set the barcode rotation angle measure in degrees, for best results use 0, 90, 180 or 270. Example: 0
- `rows` (`integer`, optional): Set the number of rows. Example: 10
- `size_mode` (`string`, optional): Set the barcode auto sizing mode. One of: None, Nearest, Fixed, Interpolation. Example: None. One of: `None`, `Nearest`, `Fixed`, `Interpolation`.
- `supplement_data` (`string`, optional): Set the supplement data that follows the barcode. Example: example
- `supplement_space` (`integer`, optional): Set the space between the main barcode and supplement barcode. Example: 0
- `wide_narrow_ratio` (`number`, optional): Set the ratio of wide bars to narrow bars (default 3 i.e. Wide bars are 3 times wider than narrow bars). Example: 3
- `width` (`integer`, optional): Set the barcode width (pixels). Example: 12345
- `x_dimension` (`number`, optional): Set minimum width of the barcode bars (pixels). Example: 10

Example input: `{"code_text_encoding":"Default","dot_codemask":-1}`

### `encodian_csv_parse`

Parse CSV · Write

Parse a CSV file into JSON rows.
Returns csvData, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the rows as JSON. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `csv_column_headers` (`string`, optional): Manually set the column headers for the CSV data (Column delimited: Column 1, Column 2, etc. Example: example
- `delimiter` (`string`, optional): Set the CSV delimiter, the default value is a comma: ','. Example: ,
- `encoding` (`string`, optional): Set the character encoding used to process the CSV file. One of: ASCII, ISO88591, ISO88592, Latin1, UTF8. Example: ISO88591. One of: `ASCII`, `ISO88591`, `ISO88592`, `Latin1`, `UTF8`.
- `skip_first_line` (`boolean`, optional): Skip the first line of the CSV file, set to 'Yes' if your CSV document contains column headers. Example: true

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_date_calculate`

Calculate Date · Write

Add or subtract an interval of days, weeks, months or years from a date, optionally skipping given days.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns the new date. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): The date value to calculate. Example: 2026-03-01T09:00:00Z
- `interval` (`integer`, required): Set amount of time to add or subtract from the 'Date' value provided. Example: 5
- `measurement` (`string`, required): Set the time measurement used for the calculation. One of: Ticks, Milliseconds, Seconds, Minutes, Hours, Days, Months, Years. Example: Days. One of: `Ticks`, `Milliseconds`, `Seconds`, `Minutes`, `Hours`, `Days`, `Months`, `Years`.
- `operation` (`string`, required): Set the operation type, either add or subtract. One of: Add, Subtract. Example: Add. One of: `Add`, `Subtract`.
- `dates_to_exclude` (`string`, optional): Specify the dates to be excluded from the calculation as a comma-delimited list, for example: 25/12/2024,26/12/2024. Example: []
- `days_to_exclude` (`string`, optional): Specify the days to be excluded from the calculation as a comma-delimited list, for example: Saturday, Sunday. Example: []

Example input: `{"date":"<date>","interval":5,"measurement":"Ticks","operation":"Add"}`

### `encodian_date_format`

Format Date · Write

Format a date value with a .NET date format string.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns the formatted date. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): The date value to format. Example: 2026-03-01T09:00:00Z
- `format` (`string`, required): Set the date format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. Example: dd MMMM yyyy

Example input: `{"date":"<date>","format":"<format>"}`

### `encodian_email_address_validate`

Validate Email Address · Write

Check that an email address is syntactically valid.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns true or false. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email_address` (`string`, required): The email address to verify. Example: jane@example.com
- `regex` (`string`, required): The regular expression used for validation. Example: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}

Example input: `{"email_address":"<email_address>","regex":"<regex>"}`

### `encodian_email_info_get`

Extract Email Metadata · Write

Extract metadata (sender, recipients, subject, dates, body) from an .eml or .msg email file.
Returns subject, bodyText, bodyHtml, to, toArray, cc, ccArray, bcc, bccArray, from.
Pass the email file as base64. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK

Example input: `{"file_content":"<file_content>"}`

### `encodian_excel_rows_add`

Add Rows to Excel · Write

Add rows from JSON data to an Excel worksheet or table.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `json_data` (`string`, required): The JSON dataset to be processed and added as rows to the Excel file provided. Example: [{"Name": "Jane", "Total": 120}]
- `convert_numeric_and_date` (`boolean`, optional): Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date'. Example: false
- `date_format` (`string`, optional): Set the date and time format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. Example: yyyy-MM-dd
- `ignore_attribute_titles` (`boolean`, optional): Ignores titles of JSON attributes when converting JSON to Excel. Example: true
- `ignore_nulls` (`boolean`, optional): Ignore JSON properties which contain null values. Example: false
- `insertion_column` (`integer`, optional): The column number after which the data provided will be inserted. Example: 10
- `insertion_row` (`integer`, optional): The row number after which the data provided will be inserted. Example: 10
- `numeric_format` (`string`, optional): Set the numeric format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings. Example: 0.00
- `table_name` (`string`, optional): Specify the name of a table which the data provided will be appended. When setting this property the 'Insert from Row' and 'Insert from Column' values will be ignored. Example: Table1
- `worksheet_name` (`string`, optional): Specify the name of a specific worksheet. Example: Sheet1

Example input: `{"file_content":"<file_content>","json_data":"<json_data>"}`

### `encodian_excel_rows_get`

Extract Rows from Excel · Write

Extract rows from an Excel worksheet as JSON, with row and column limits.
Returns rowData, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the rows as JSON. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `always_export_as_json_object` (`boolean`, optional): Force row data to be exported as a JsonObject even when there is only a single worksheet contained within the file. Example: false
- `exclude_empty_rows` (`boolean`, optional): Set whether empty rows should be excluded from the export. Example: true
- `exclude_hidden_columns` (`boolean`, optional): Set whether hidden columns should be excluded from the export. Example: false
- `exclude_hidden_rows` (`boolean`, optional): Set whether hidden rows should be excluded from the export. Example: false
- `export_empty_cells` (`boolean`, optional): Set whether empty cells should be exported. Example: true
- `export_values_as_text` (`boolean`, optional): Set whether values should be exported as text, i.e. a number would be exported as "value":"3". Example: false
- `first_column` (`integer`, optional): Set the number of the first column to be exported. Example: 10
- `first_row` (`integer`, optional): Set the number of the first row to be exported. Example: 10
- `has_header_row` (`boolean`, optional): Set whether the first row specified is a header row. Example: true
- `hyperlink_format` (`string`, optional): Set how Hyperlinks should be exported. One of: Title, URL, HTML. Example: Title. One of: `Title`, `URL`, `HTML`.
- `last_column` (`integer`, optional): Set the number of the last column to be exported. Example: 10
- `last_row` (`integer`, optional): Set the number of the last row to be rows to be exported. Example: 10
- `worksheet_name` (`string`, optional): Set the name of a specific worksheet to be exported. Example: Sheet1

Example input: `{"file_content":"<file_content>"}`

### `encodian_excel_template_populate`

Populate Excel Template · Write

Fill an Excel template's merge fields from JSON data.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `json_data` (`string`, required): The JSON data to populate the Microsoft Excel wookbook with. Example: [{"Name": "Jane", "Total": 120}]
- `allow_missing_members` (`boolean`, optional): Sets the engine to allow missing values within the 'JSON Data'. Example: true
- `calculate_workbook` (`boolean`, optional): Automatically calculate formulas upon population. Example: true
- `date_time_format` (`string`, optional): Set one or more specfic formats for parsing DateTime values. Example: yyyy-MM-dd
- `inline_error_messages` (`boolean`, optional): Produces errors within the resultant workbook as opposed to rejecting the request with a HTTP 4 error. Example: true
- `json_parse_mode` (`string`, optional): Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) One of: Standard, Strict. Example: Standard. One of: `Standard`, `Strict`.
- `remove_empty_paragraphs` (`boolean`, optional): Sets the engine to automatically removes any empty paragraphs upon execution. Example: true
- `use_excel_data_types` (`boolean`, optional): When enabled data is added to the workbook using corresponding Excel data types as opposed to a string data type. Example: true

Example input: `{"file_content":"<file_content>","json_data":"<json_data>"}`

### `encodian_file_to_pdf_convert`

Convert File to PDF · Write

Convert an Office document, image, email or other file to PDF or PDF/A.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `generate_bookmarks` (`boolean`, optional): Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF. Example: true
- `pdfa_compliance` (`boolean`, optional): Set PDF/A Compliance option. Example: false
- `pdfa_compliance_level` (`string`, optional): Set the PDF/A Compliance Level, the default value is PDF_A_2A. Example: PDF_A_2A. One of: `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`.
- `remove_document_markup` (`boolean`, optional): Set MS Office document comments and tracked changes removal option. Example: true

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","output_filename":"<output_filename>"}`

### `encodian_files_to_excel_merge`

Merge Excel Files · Write

Merge several Excel or CSV files into one workbook.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `documents` (`array`, required): Files to merge, as a JSON array of objects with fileName (including extension) and base64 fileContent. Example: [{"fileName": "a.pdf", "fileContent": "JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}]
- `merge_excel_output_format` (`string`, optional): The format of the output excel file. One of: PDF, CSV, TIFF, XLSX, XLS, XLSB, XLSM. Example: XLSX. One of: `PDF`, `CSV`, `TIFF`, `XLSX`, `XLS`, `XLSB`, `XLSM`.
- `output_filename` (`string`, optional): File name for the output file, including its extension. Example: output.pdf

Example input: `{"documents":[{"fileName":"a.pdf","fileContent":"JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}]}`

### `encodian_files_to_pdf_merge`

Merge Files to PDF · Write

Merge several files (PDF, Office, images) into one PDF, in the order given.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `documents` (`array`, required): Files to merge, as a JSON array of objects with fileName (including extension) and base64 fileContent. Example: [{"fileName": "a.pdf", "fileContent": "JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}]
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `generate_bookmarks` (`boolean`, optional): Generate a bookmark for each merged PDF document. Example: true
- `page_normalisation` (`boolean`, optional): Set whether to normalise the page width/height to the dimensions of the first file. Example: false
- `pdfa_compliance` (`boolean`, optional): Set PDF/A Compliance option. Example: false
- `pdfa_compliance_level` (`string`, optional): Set the PDF/A Compliance Level, the default value is PDF_A_2A. Example: PDF_A_2A. One of: `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`.
- `preserve_bookmarks` (`boolean`, optional): Preserve bookmarks contained within each merged PDF document. Example: false
- `remove_document_markup` (`boolean`, optional): Set MS Office document comments and tracked changes removal option. Example: false

Example input: `{"documents":[{"fileName":"a.pdf","fileContent":"JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}],"file_name":"<file_name>","output_filename":"<output_filename>"}`

### `encodian_files_to_word_merge`

Merge Files to Word · Write

Merge several Word documents into one, in the order given.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `documents` (`array`, required): Files to merge, as a JSON array of objects with fileName (including extension) and base64 fileContent. Example: [{"fileName": "a.pdf", "fileContent": "JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}]
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `merge_content` (`boolean`, optional): Set whether the content from each file should also be merged, alongside the files. Example: false
- `quick_part_mapping` (`string`, optional): Set quick part data to be mapped from the first or last document, or removed. One of: First, Last, None. Example: None. One of: `First`, `Last`, `None`.
- `timezone` (`string`, optional): Set a specific time zone for date and time processing. Example: UTC. One of: `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`.
- `word_compliance_level` (`string`, optional): Specify which OOXML specification will be used when saving in the DOCX format. One of: Ecma, Transitional, Strict. Example: Transitional. One of: `Ecma`, `Transitional`, `Strict`.

Example input: `{"documents":[{"fileName":"a.pdf","fileContent":"JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}],"output_filename":"<output_filename>"}`

### `encodian_hash_create`

Create Hash · Write

Compute a hash (MD5, SHA-1, SHA-256, SHA-512) of a value.
Returns HashCode, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the hash string. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data` (`string`, required): Provide the input data to be computed. Example: hello world
- `digest_algorithm` (`string`, required): Select the message digest algorithm. One of: SHA1, SHA256, SHA384, SHA512, MD5, RIPEMD160. Example: SHA256. One of: `SHA1`, `SHA256`, `SHA384`, `SHA512`, `MD5`, `RIPEMD160`.
- `case` (`string`, optional): Set the case applied to the computed value. One of: Lower, Upper. Example: Lower. One of: `Lower`, `Upper`.
- `crypto_input_data_type` (`string`, optional): Set the data format for the input data provided. One of: TEXT, HEX, BASE64, FILE. Example: TEXT. One of: `TEXT`, `HEX`, `BASE64`, `FILE`.
- `crypto_output_data_type` (`string`, optional): Set the data format for the hash code generated. One of: HASH, BASE64, HEX. Example: HASH. One of: `HASH`, `BASE64`, `HEX`.
- `encoding` (`string`, optional): Select the encoding type. One of: UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode, Default. Example: ASCII. One of: `UTF8`, `UTF7`, `UTF32`, `ASCII`, `Unicode`, `BigEndianUnicode`, `Default`.

Example input: `{"data":"<data>","digest_algorithm":"SHA1"}`

### `encodian_html_table_parse`

Parse HTML Table · Write

Parse a table in HTML (inline or a file) into JSON rows.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Pick the table by index or ID. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `content_filter` (`string`, optional): Set that only table cells which match the specified type will be parsed. One of: All, DateTime, Integer, Currency, Decimal. Example: All. One of: `All`, `DateTime`, `Integer`, `Currency`, `Decimal`.
- `file_content` (`string`, optional): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `generate_headers` (`boolean`, optional): When table header tags ( ) are not present, generate headers using the first row ( ) Example: false
- `html` (`string`, optional): Optional - The HTML to be parsed. Example: <table><tr><th>Name</th></tr><tr><td>Jane</td></tr></table>
- `quantity_filter` (`integer`, optional): Get the rows with the specified number of columns. Example: 10
- `table_id` (`string`, optional): Set the ID of the HTML table to parse, when more than one table is present within the HTML. Example: orders
- `table_index` (`integer`, optional): Set the index of the HTML table to parse, when more than one table is present within the HTML (The default is 1) Example: 10

Example input: `{}`

### `encodian_html_to_pdf_convert`

Convert HTML to PDF · Write

Convert HTML (inline, a URL or an HTML file) to a PDF document.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `encoding` (`string`, required): Set the encoding type for the HTML. One of: UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode. Example: UTF8. One of: `UTF8`, `UTF7`, `UTF32`, `ASCII`, `Unicode`, `BigEndianUnicode`.
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `create_pdf_form` (`boolean`, optional): Set whether the HTML content should be converted to a PDF form. Example: false
- `css_type` (`string`, optional): Set whether the standard or print style sheets should be used for HTML conversion. One of: Screen, Print. Example: Screen. One of: `Screen`, `Print`.
- `decode_html_data` (`boolean`, optional): Set whether the data provided in the HTML Data field should be decoded. Example: true
- `delay` (`integer`, optional): Set the delay in milliseconds between the HTML being received and the conversion to allo time for JavaScript to load. Example: 2000
- `enable_bookmarks` (`boolean`, optional): Enable or disable auto creation of PDF bookmarks. Example: true
- `enable_hyperlinks` (`boolean`, optional): Enable or disable hyperlinks. Example: true
- `enable_java_script` (`boolean`, optional): Enable or disable javascript. Example: true
- `file_content` (`string`, optional): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `html_data` (`string`, optional): Optional - The HTML which will be converted to a PDF document. Example: <html><body><h1>Invoice 1042</h1></body></html>
- `html_url` (`string`, optional): Optional - The web address to the web page which will be converted to a PDF document. Example: https://example.com/invoice.html
- `margin_bottom` (`number`, optional): Set the bottom margin value (pixels) Example: 25
- `margin_left` (`number`, optional): Set the left margin value (pixels) Example: 25
- `margin_right` (`number`, optional): Set the right margin value (pixels) Example: 25
- `margin_top` (`number`, optional): Set the top margin value (pixels) Example: 25
- `page_height` (`integer`, optional): Set the page height value (pixels) Example: 0
- `page_orientation` (`string`, optional): Set page oprientation (Landscape or portrait). One of: Portrait, Landscape. Example: Portrait. One of: `Portrait`, `Landscape`.
- `page_size` (`string`, optional): Set the page size for the output PDF document, A4 is the default size. Example: A4. One of: `Default`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `B4`, `B5`, `EnvelopeDL`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Quarto`, `Statement`, `Tabloid`, `Custom`.
- `page_width` (`integer`, optional): Set the page width value (pixels) Example: 0
- `repeat_table_footer` (`boolean`, optional): Set whether to repeat the table footer on every page break. The default value is true. Example: true
- `repeat_table_header` (`boolean`, optional): Set whether to repeat the table header on every page break. The default value is true. Example: true
- `split_images` (`boolean`, optional): Set whether to split images. Example: false
- `split_text_lines` (`boolean`, optional): Set whether to split text lines. Example: false
- `view_port` (`string`, optional): Set the viewport used to render the HTML. One of: Default, Mobile, Tablet, Laptop, LaptopL, FourK. Example: Default. One of: `Default`, `Mobile`, `Tablet`, `Laptop`, `LaptopL`, `FourK`.

Example input: `{"encoding":"UTF8","file_name":"<file_name>","output_filename":"<output_filename>"}`

### `encodian_html_to_word_convert`

Convert HTML to Word · Write

Convert HTML (inline, a URL or an HTML file) to a Word document.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `decode_html_data` (`boolean`, optional): Set whether the data provided in the HTML Data field should be decoded. Example: true
- `encoding` (`string`, optional): Set the encoding type for the HTML. One of: UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode. Example: UTF8. One of: `UTF8`, `UTF7`, `UTF32`, `ASCII`, `Unicode`, `BigEndianUnicode`.
- `file_content` (`string`, optional): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `html_data` (`string`, optional): Optional - The HTML which will be converted to a Word document. Example: <html><body><h1>Invoice 1042</h1></body></html>
- `html_url` (`string`, optional): Optional - The web address to the web page which will be converted to a Word document. Example: https://example.com/invoice.html
- `margin_bottom` (`number`, optional): Set the bottom margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. Example: -1
- `margin_left` (`number`, optional): Set the left margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. Example: -1
- `margin_right` (`number`, optional): Set the right margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. Example: -1
- `margin_top` (`number`, optional): Set the top margin value (pt. The default value is set to -1, whereby a minus value does not change the existing page margin value. Example: -1
- `page_height` (`integer`, optional): Set the page height value (pixels) Example: 0
- `page_orientation` (`string`, optional): Set page oprientation (Landscape or portrait). One of: Portrait, Landscape. Example: Portrait. One of: `Portrait`, `Landscape`.
- `page_size` (`string`, optional): Set the page size for the output Word document, A4 is the default size. Example: A4. One of: `Default`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `B4`, `B5`, `EnvelopeDL`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Quarto`, `Statement`, `Tabloid`, `Custom`.
- `page_width` (`integer`, optional): Set the page width value (pixels) Example: 0
- `word_compliance_level` (`string`, optional): Set the compliance level applied to the HTML source during conversion. One of: Ecma, Transitional, Strict. Example: Ecma. One of: `Ecma`, `Transitional`, `Strict`.

Example input: `{"file_name":"<file_name>","output_filename":"<output_filename>"}`

### `encodian_image_compress`

Compress Image · Write

Reduce an image's file size.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `image_type` (`string`, required): Select the image file format. One of: JPG, PNG. Example: JPG. One of: `JPG`, `PNG`.
- `compression_level` (`string`, optional): Set the compression level where a higher level provides greater compression. One of: Default, Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8, Level9. Example: Default. One of: `Default`, `Level1`, `Level2`, `Level3`, `Level4`, `Level5`, `Level6`, `Level7`, `Level8`, `Level9`.

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","image_type":"JPG"}`

### `encodian_image_format_convert`

Convert Image Format · Write

Convert an image to another format, such as PNG to JPG.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `current_image_format` (`string`, required): Select the current image file format. One of: BMP, GIF, JPG, PNG, TIF, HEIC. Example: BMP. One of: `BMP`, `GIF`, `JPG`, `PNG`, `TIF`, `HEIC`.
- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `new_image_format` (`string`, required): Select the new image file format. One of: BMP, GIF, JPG, PNG, TIF. Example: BMP. One of: `BMP`, `GIF`, `JPG`, `PNG`, `TIF`.

Example input: `{"current_image_format":"BMP","file_content":"<file_content>","file_name":"<file_name>","new_image_format":"BMP"}`

### `encodian_image_resize`

Resize Image · Write

Resize an image by percentage or to a width and height.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `image_resize_type` (`string`, required): Set whether the image should be resized to a ratio or specific dimensions. One of: Percentage, Specific. Example: Percentage. One of: `Percentage`, `Specific`.
- `aspect_ratio_dimension` (`string`, optional): Used when 'Maintain Aspect Ratio' is true and both 'Image Width' and 'Image Height' are provided. Determines which dimension is treated as the fixed value when calculating the other dimension. One of: Width, Height, Largest. Example: Width. One of: `Width`, `Height`, `Largest`.
- `image_height` (`integer`, optional): For specific resize actions - Set the specific height of the image in pixels. Example: 10
- `image_resize_resolution_mode` (`string`, optional): Controls how the image resolution is changed when an 'Image Resolution' value is provided. 'Metadata' only updates the image DPI/PPI metadata without resampling pixels. 'Resample' adjusts pixel dimensions only when no explicit width, height, or percentage resize is requested. One of: Metadata, Resample. Example: Metadata. One of: `Metadata`, `Resample`.
- `image_resolution` (`integer`, optional): Optional - Specify an image resolution, by default the current image resolution will be used. Example: 10
- `image_width` (`integer`, optional): For specific resize actions - Set the specific width of the image in pixels. Example: 12345
- `maintain_aspect_ratio` (`boolean`, optional): Only used when 'Resize Type' is 'Specific'. If true, 'Image Width' or 'Image Height' is automatically calculated when only one dimension is provided. If both are provided, the 'Aspect Ratio Dimension' property determines which dimension is fixed. Example: true
- `resize_percentage` (`integer`, optional): For percentage resize actions - Set the percentage the image should be decrased or increased in size by. Example: 25

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","image_resize_type":"Percentage"}`

### `encodian_image_text_extract`

Extract Text from Image (OCR) · Write

Read the text in an image with AI OCR, with optional clean-up.
Returns Text, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the text. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `auto_rotate_confidence_level` (`integer`, required): Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 70. Example: 0
- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `image_type` (`string`, required): Select the image file format. One of: JPG, PNG, TIFF, BMP. Example: JPG. One of: `JPG`, `PNG`, `TIFF`, `BMP`.
- `adjust_brightness_contrast` (`boolean`, optional): This action analyzes a document and automatically adjusts brightness and contrast based on the analysis. Example: false
- `apply_average_filter` (`boolean`, optional): Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window. Example: false
- `auto_rotate` (`boolean`, optional): Automatically detects orientation and rotates it so that the text on it is upright oriented. Example: false
- `binarize` (`boolean`, optional): 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. Example: false
- `clean_up_type` (`string`, optional): Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document. One of: Default, None, Specific. Example: None. One of: `Default`, `None`, `Specific`.
- `deskew` (`boolean`, optional): Detects the skew angle and rotates to remove that skew. Example: false
- `despeckle` (`boolean`, optional): Automatically detects speckles and removes them. Example: false
- `image_detergent` (`boolean`, optional): 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. Example: false
- `ocr_language` (`string`, optional): Select the language used for OCR processing. Example: English. One of: `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`.
- `remove_border` (`boolean`, optional): Locates border pixels and removes the pixels from the document,this is disabled by default. Example: false
- `remove_dot_shading` (`boolean`, optional): This action will remove shaded regions from bitonal documents. Example: false
- `remove_hole_punch` (`boolean`, optional): Detects and removes hole punch marks from a bitonal document. Example: false
- `smooth_background` (`boolean`, optional): This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise. Example: false
- `smooth_objects` (`boolean`, optional): 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. Example: false

Example input: `{"auto_rotate_confidence_level":0,"file_content":"<file_content>","file_name":"<file_name>","image_type":"JPG"}`

### `encodian_json_to_excel_convert`

Convert JSON to Excel · Write

Convert JSON data into an Excel workbook, optionally into an existing file.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `column` (`integer`, optional): The first column to be written to. Example: 0
- `convert_numeric_and_date` (`boolean`, optional): Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date'. Example: false
- `date_format` (`string`, optional): Set the date and time format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. Example: yyyy-MM-dd
- `file_content` (`string`, optional): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `ignore_attribute_titles` (`boolean`, optional): Ignores titles of JSON attributes when converting JSON to Excel. Example: false
- `ignore_nulls` (`boolean`, optional): Ignore JSON properties which contain null values. Example: false
- `is_title_bold` (`boolean`, optional): Set the title to bold. Example: true
- `is_title_text_wrapped` (`boolean`, optional): Set whether a titles text is wrapped. Example: true
- `json_data` (`string`, optional): Optional - The JSON data to be converted to an Excel document. Example: [{"Name": "Jane", "Total": 120}]
- `numeric_format` (`string`, optional): Set the numeric format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings. Example: 0.00
- `row` (`integer`, optional): The first row to be written to. Example: 0
- `title_font_colour` (`string`, optional): Set the title font color. Example: Black. One of: `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`.
- `worksheet_name` (`string`, optional): The name of the worksheet that the JSON data is added to. Example: Sheet1

Example input: `{"output_filename":"<output_filename>"}`

### `encodian_json_to_xml_convert`

Convert JSON to XML · Write

Convert a JSON string to XML.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Use encodian_xml_to_json_convert for the reverse. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `json` (`string`, required): The JSON to convert to XML. Example: {"order": {"id": 1042}}
- `include_array_attribute` (`boolean`, optional): Set whether to include an array attribute for collections. Example: false
- `root_name` (`string`, optional): Set the name of the the 'Root' XML element. Example: root

Example input: `{"json":"<json>"}`

### `encodian_password_generate`

Generate Password · Write

Generate a random password with the chosen length and character sets.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns the password. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `length` (`integer`, required): Set the length of the password. Example: 16
- `exclude_characters` (`string`, optional): Specify a list of characters to exclude from the password. Example: O0l1
- `include_lower_case` (`boolean`, optional): Set whether lower case characters should be included within the password. Example: true
- `include_numbers` (`boolean`, optional): Set whether numbers should be included within the password. Example: true
- `include_symbols` (`boolean`, optional): Set whether symbols should be included within the password. Example: true
- `include_upper_case` (`boolean`, optional): Set whether upper case characters should be included within the password. Example: true

Example input: `{"length":16}`

### `encodian_pdf_compress`

Compress PDF · Write

Reduce a PDF's size by compressing images and removing unused objects.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `allow_reuse_page_content` (`boolean`, optional): Page contents will be reused when the PDF document is optimized for equal pages. Example: true
- `compress_images` (`boolean`, optional): Contained images will be compressed, aligned to the value of the 'Image Quality' property. Example: true
- `delete_annotations` (`boolean`, optional): Delete all annotations contained within the PDF document. Example: false
- `flatten_annotations` (`boolean`, optional): Flatten all annotations contained within the PDF document. Example: true
- `flatten_fields` (`boolean`, optional): Flatten all fields contained within the PDF document (AcroForms only). Example: true
- `image_quality` (`integer`, optional): Sets the quality for compressed images: 1 > 100. Example: 80
- `link_duplicate_streams` (`boolean`, optional): 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). Example: true
- `max_resolution` (`integer`, optional): Specifies the maximum resolution of images (dpi), if the image has a higher resolution it will be scaled dynamically. Example: 150
- `remove_private_info` (`boolean`, optional): Remove private information from the PDF document, i.e. page piece information. Example: false
- `remove_unused_objects` (`boolean`, optional): Remove all unused objects (i.e. objects which do not have a reference) are removed from PDF document. Example: true
- `remove_unused_streams` (`boolean`, optional): Remove all unused resources from the PDF document. Example: true
- `resize_images` (`boolean`, optional): If 'Compress Images' and 'Resize Images' are enabled, images will be resized where the image resolution is greater than the specified 'Max Resolution' property. Example: false
- `unembed_fonts` (`boolean`, optional): 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. Example: false

Example input: `{"file_content":"<file_content>"}`

### `encodian_pdf_form_data_extract`

Extract PDF Form Data · Write

Extract the field names and values of a fillable PDF form as JSON.
Returns Form Data, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Use encodian_pdf_form_fill to fill a form. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_pdf_form_fill`

Fill PDF Form · Write

Fill a PDF form's fields from a JSON object of field names and values.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Get field names with encodian_pdf_form_data_extract. Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `form_data` (`string`, required): The JSON data to populate with the PDF Form with. Example: {"FullName": "Jane Doe"}

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","form_data":"<form_data>"}`

### `encodian_pdf_info_get`

Extract PDF Metadata · Write

Get a PDF's metadata: page count, author, title, dates, permissions and file size.
Returns NumberOfPages, FileSize, Author, Creator, Producer, Title, Subject, Keywords, customProperties, Orientation.
Use this before splitting or extracting pages. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_pdf_ocr_apply`

Apply OCR to PDF · Write

Run OCR on a scanned PDF to add a searchable text layer, with optional image clean-up.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `auto_rotate_confidence_level` (`integer`, required): Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60. Example: 0
- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `adjust_brightness_contrast` (`boolean`, optional): This action analyzes a document and automatically adjusts brightness and contrast based on the analysis. Example: true
- `apply_average_filter` (`boolean`, optional): Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window. Example: false
- `auto_rotate` (`boolean`, optional): Automatically detects orientation and rotates it so that the text on it is upright oriented. Example: true
- `binarize` (`boolean`, optional): 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. Example: false
- `clean_up_type` (`string`, optional): Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document. One of: Default, None, Specific. Example: None. One of: `Default`, `None`, `Specific`.
- `deskew` (`boolean`, optional): Detects the skew angle and rotates to remove that skew. Example: true
- `despeckle` (`boolean`, optional): Automatically detects speckles and removes them. Example: true
- `image_detergent` (`boolean`, optional): 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. Example: false
- `ocr_language` (`string`, optional): Select the language used for OCR processing. Example: English. One of: `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`.
- `ocr_type` (`string`, optional): Select the OCR processing type, the 'Fast' option reduces processing time with possible minor loss of OCR accuracy - https://support.encodian.com/hc/en-gb/articles/360012686653-OCR-a-PDF-Document. One of: Quality, Fast. Example: Quality. One of: `Quality`, `Fast`.
- `pdfa_compliance` (`boolean`, optional): Set PDF/A Compliance option. Example: false
- `pdfa_compliance_level` (`string`, optional): Set the PDF/A Compliance Level, the default value is PDF_A_2A. Example: PDF_A_2A. One of: `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`.
- `remove_blank_pages` (`boolean`, optional): Set whether blank pages should be removed from the PDF document. Example: false
- `remove_border` (`boolean`, optional): Locates border pixels and removes the pixels from the document,this is disabled by default. Example: false
- `remove_dot_shading` (`boolean`, optional): This action will remove shaded regions from bitonal documents. Example: false
- `remove_hole_punch` (`boolean`, optional): Detects and removes hole punch marks from a bitonal document. Example: false
- `smooth_background` (`boolean`, optional): This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise. Example: false
- `smooth_objects` (`boolean`, optional): 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. Example: false

Example input: `{"auto_rotate_confidence_level":0,"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_pdf_page_numbers_add`

Add Page Numbers to PDF · Write

Add page numbers to a PDF with format, position and font options.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `add_to_background` (`boolean`, optional): Set whether the page number(s) should be added to top or bottom layer of the PDF document. The default setting (false) adds the page number(s) to the top layer. Example: false
- `custom_number_format` (`string`, optional): Set a custom number format, for example '{0:00000}' would generate 00001. Example: Page [PageNumber] of [TotalPages]
- `font` (`string`, optional): Specify the name of the font, if the font cannot be found the default 'Arial' will be used. Example: Arial
- `font_colour` (`string`, optional): Set the HTML colour of the font, the default colour is set to #000000. Example: #000000
- `font_size` (`integer`, optional): Set the size of the font, the default size is set to 14. Example: 14
- `horizontal_alignment` (`string`, optional): Set the horizontal alignment of the page number(s) added to the document, the default value is Center. One of: None, Left, Center, Right, Justify, FullJustify. Example: Center. One of: `None`, `Left`, `Center`, `Right`, `Justify`, `FullJustify`.
- `margin_bottom` (`number`, optional): Set the bottom margin value (pt). The default value is set to 20. Example: 20
- `margin_left` (`number`, optional): Set the left margin value (pt). The default value is set to 20. Example: 20
- `margin_right` (`number`, optional): Set the right margin value(pt). The default value is set to 20. Example: 20
- `margin_top` (`number`, optional): Set the top margin value (pt). The default value is set to 20. Example: 20
- `opacity` (`number`, optional): Set the opacity of the page number(s), valid values range from 0.0+ to 1.0, the default value is 1.0. Example: 1
- `page_number_format` (`string`, optional): Set the format of the page number(s) added to the document, where [PageNumber] is replaced by the current page number and [TotalPages] is replaced by the total number of pages. Example: [PageNumber] of [TotalPages]
- `start_number` (`integer`, optional): Set the starting number for the page number(s) added to the document. Example: 1
- `start_page` (`integer`, optional): Set which page to start adding page number(s) from. Example: 1

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_pdf_pages_delete`

Delete PDF Pages · Write

Remove a page range or specific pages from a PDF.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `end_page` (`integer`, optional): Set the page number to stop deleting pages on. The default value is set to the last page of the PDF document provided. Example: 2
- `page_numbers` (`string`, optional): A comma separated list of page numbers of the pages to delete: 1,3,4. Example: 1,3
- `start_page` (`integer`, optional): Set the page number to begin deleting pages from. Example: 1

Example input: `{"file_content":"<file_content>"}`

### `encodian_pdf_pages_extract`

Extract PDF Pages · Write

Extract a page range or specific pages from a PDF into a new PDF.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `end_page` (`integer`, optional): Set the page number to stop extracting pages on. The default value is set to the last page of the PDF document provided. Example: 2
- `page_numbers` (`string`, optional): A comma separated list of page numbers of the pages to extract: 1,3,4. Example: 1,3
- `start_page` (`integer`, optional): Set the page number to begin extracting pages from. Example: 1

Example input: `{"file_content":"<file_content>"}`

### `encodian_pdf_redact`

Redact PDF · Write

Permanently redact text that matches the given phrases or patterns from a PDF.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `redactions` (`array`, required): The collection of redactions to apply to this PDF document. Example: [{"SearchText": "Jane Doe"}]

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","redactions":[{"SearchText":"Jane Doe"}]}`

### `encodian_pdf_secure`

Secure PDF · Write

Password-protect a PDF and set its printing, copying and editing permissions.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Use encodian_pdf_unlock to remove protection. Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `admin_password` (`string`, optional): Protect edit access to the document. Example: Adm1n!pass
- `crypto_algorithm` (`string`, optional): Set the cryptographic algorithm. One of: RC4x40, RC4x128, AESx128, AESx256, Custom. Example: AESx256. One of: `RC4x40`, `RC4x128`, `AESx128`, `AESx256`, `Custom`.
- `pdf_privileges` (`string`, optional): Set the privileges assigned to the PDF document. One of: AllowAll, DenyAll, Specific. Example: DenyAll. One of: `AllowAll`, `DenyAll`, `Specific`.
- `pdf_privileges_allow_assembly` (`boolean`, optional): Set whether document assembly is permitted. Example: false
- `pdf_privileges_allow_copy` (`boolean`, optional): Set whether copy is permitted. Example: false
- `pdf_privileges_allow_fill_in` (`boolean`, optional): Set whether 'Fill in forms' is permitted. Example: false
- `pdf_privileges_allow_modify_annotations` (`boolean`, optional): Set whether annotation modification is permitted. Example: false
- `pdf_privileges_allow_modify_contents` (`boolean`, optional): Set whether document content modification is permitted. Example: false
- `pdf_privileges_allow_print` (`boolean`, optional): Set whether print is permitted. Example: false
- `pdf_privileges_allow_screen_readers` (`boolean`, optional): Set whether screen reading is permitted. Example: false
- `user_password` (`string`, optional): Protect view access to the document. Example: S3cret!pass

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_pdf_split`

Split PDF · Write

Split a PDF into several files by page numbers, page count or bookmarks.
Returns documents, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the parts as base64 files. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `split_by_type` (`string`, required): Select how to split the file. One of: NumberOfPages, PageArray, BookmarkLevel. Example: NumberOfPages. One of: `NumberOfPages`, `PageArray`, `BookmarkLevel`.
- `split_configuration` (`string`, required): Provide a split configuration. Example: 1,3,5
- `enable_bookmark_filenames` (`boolean`, optional): Append the bookmark name value to the filename when splitting by 'BookmarkLevel'. Example: false

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","split_by_type":"NumberOfPages","split_configuration":"<split_configuration>"}`

### `encodian_pdf_tables_extract`

Extract Table Data from PDF · Write

Extract the tables in a PDF as structured JSON data.
Returns result, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Use encodian_pdf_to_excel_convert to get a workbook instead. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `end_page` (`integer`, optional): Optional - Specifies the page number to stop extracting pages on. Example: 2
- `extract` (`string`, optional): Specify the table to extract. One of: First, Last, Custom. Example: First. One of: `First`, `Last`, `Custom`.
- `has_header_row` (`boolean`, optional): Set whether the first row is a header row. Example: true
- `start_page` (`integer`, optional): Optional - Specifies the page number to start extracting pages from. Example: 1
- `table_index` (`integer`, optional): Optional - If 'Extract' is set to 'Custom', specify the index of the table to extract. Example: 10

Example input: `{"file_content":"<file_content>"}`

### `encodian_pdf_text_extract`

Extract Text from PDF · Write

Extract the text layer of a PDF, optionally for a page range.
Returns TextLayer, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Use encodian_pdf_ocr_apply first for scanned PDFs. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `end_page` (`integer`, optional): Sets the page number to end text layer extraction from. The default value is set to the last page of the PDF document provided. Example: 2
- `remove_control_characters` (`boolean`, optional): Set whether to automatically remove 'Control Characters' from the extracted text. Example: true
- `start_page` (`integer`, optional): Sets the page number to begin text layer extraction from. Example: 1
- `text_encoding_type` (`string`, optional): The encoding type used for text extraction. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: UTF8. One of: `Default`, `Latin1`, `BigEndianUnicode`, `UTF16`, `UTF8`, `UTF7`, `ASCII`.

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_pdf_text_watermark_add`

Add Text Watermark to PDF · Write

Add a text watermark (for example CONFIDENTIAL) to every page of a PDF.
Returns watermarkId, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `text` (`string`, required): The text to embed as a watermark within the document. Example: CONFIDENTIAL
- `font` (`string`, optional): The font applied to the text watermark, the default font is set to Arial. Example: Arial
- `horizontal_alignment` (`string`, optional): Set the horizontal alignment of the watermark, the default value is Center. One of: Left, Center, Right, FullJustify, Justify, None. Example: Center. One of: `Left`, `Center`, `Right`, `FullJustify`, `Justify`, `None`.
- `opacity` (`number`, optional): The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0. Example: 1
- `orientation` (`string`, optional): The orientation of the text to embed as a watermark within the document. One of: Vertical, Horizontal, Diagonal. Example: Horizontal. One of: `Vertical`, `Horizontal`, `Diagonal`.
- `padding` (`string`, optional): A comma delimited padding configuration 5,0,5,0 in the order top, right, bottom, left. Example: 5,0,5,0
- `skip_first_page` (`boolean`, optional): Set whether to skip applying the watermark to the first page. Example: false
- `text_colour` (`string`, optional): The HTML colour applied to the text watermark, the default colour is set to #E81123. Example: #FF0000
- `text_size` (`integer`, optional): The size of the font applied to the text watermark, the default size is set to 34. Example: 34
- `vertical_alignment` (`string`, optional): Set the vertical alignment of the watermark, the default value is Center. One of: Top, Center, Bottom, None. Example: Center. One of: `Top`, `Center`, `Bottom`, `None`.

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","text":"<text>"}`

### `encodian_pdf_to_excel_convert`

Convert PDF to Excel · Write

Convert the tables in a PDF document into an Excel workbook.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK

Example input: `{"file_content":"<file_content>"}`

### `encodian_pdf_to_images_convert`

Convert PDF to Images · Write

Convert each page of a PDF into an image file.
Returns documents, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the images as base64 files. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `image_format` (`string`, required): Set the format for the output image files. One of: JPG, PNG. Example: PNG. One of: `JPG`, `PNG`.
- `filename_prefix` (`string`, optional): The prefix filename for the output image files. Example: page
- `resolution` (`integer`, optional): Set the image resolution. Example: 300

Example input: `{"file_content":"<file_content>","image_format":"JPG"}`

### `encodian_pdf_to_word_convert`

Convert PDF to Word · Write

Convert a PDF document to an editable Word document.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `mode` (`string`, optional): Mode. One of: Full, PreserveLayout. Example: Full. One of: `Full`, `PreserveLayout`.
- `recognize_bullets` (`boolean`, optional): Recognize Bullets. Example: true

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","output_filename":"<output_filename>"}`

### `encodian_pdf_unlock`

Unlock PDF · Write

Remove password protection from a PDF using its password.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `password` (`string`, required): The password to use to unlock the PDF Document. Example: S3cret!pass

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","password":"<password>"}`

### `encodian_qr_code_create`

Create QR Code · Write

Create a QR code image from text or a URL, with size, colour and logo options.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the image as base64. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `barcode_data` (`string`, required): Set the string value used to generate the QR barcode. Example: https://acme.com
- `barcode_image_format` (`string`, required): Set the image format for barcode. One of: PNG, JPG, SVG, BMP, TIFF, GIF. Example: PNG. One of: `PNG`, `JPG`, `SVG`, `BMP`, `TIFF`, `GIF`.
- `back_color` (`string`, optional): Set the QR code background color (HTML Color #FFFFFF) Example: White
- `border_color` (`string`, optional): Set the QR code border color (HTML Color #000000) Example: Black
- `border_style` (`string`, optional): Set the QR code border style. One of: Dash, DashDot, DashDotDot, Dot, Solid. Example: Solid. One of: `Dash`, `DashDot`, `DashDotDot`, `Dot`, `Solid`.
- `border_width` (`integer`, optional): Set the QR code border width in pixels. Example: 2
- `caption_above_alignment` (`string`, optional): Set the alignment of the caption text. One of: Left, Centre, Right. Example: Left. One of: `Left`, `Centre`, `Right`.
- `caption_above_font` (`string`, optional): Set the font for the caption text. Example: example
- `caption_above_font_colour` (`string`, optional): Set the font colour for the caption text. Example: Black. One of: `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`.
- `caption_above_font_size` (`integer`, optional): Set the size of font for the caption text. Example: 25
- `caption_above_no_wrap` (`boolean`, optional): Set the wrapping of the caption text. Example: true
- `caption_above_text` (`string`, optional): Set the caption above text. Example: example
- `caption_below_alignment` (`string`, optional): Set the alignment of the caption text. One of: Left, Centre, Right. Example: Left. One of: `Left`, `Centre`, `Right`.
- `caption_below_font` (`string`, optional): Set the font for the caption text. Example: example
- `caption_below_font_colour` (`string`, optional): Set the font colour for the caption text. Example: AliceBlue. One of: `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`.
- `caption_below_font_size` (`integer`, optional): Set the size of font for the caption text. Example: 25
- `caption_below_no_wrap` (`boolean`, optional): Set the wrapping of the caption text. Example: true
- `caption_below_text` (`string`, optional): Set the caption below text. Example: example
- `encode_mode` (`string`, optional): Set the QR code encode mode. One of: Auto, Bytes, ECIEncoding, ExtendedCodetext, Utf16BEBOM, Utf8BOM. Example: Auto. One of: `Auto`, `Bytes`, `ECIEncoding`, `ExtendedCodetext`, `Utf16BEBOM`, `Utf8BOM`.
- `encode_type` (`string`, optional): Set the QR code encode type. One of: Auto, ForceMicroQR, ForceQR. Example: ForceQR. One of: `Auto`, `ForceMicroQR`, `ForceQR`.
- `fore_color` (`string`, optional): Set the QR code foreground color (HTML Color #000000) Example: Black
- `height` (`integer`, optional): Set the QR code height (pixels). Example: 88
- `logo_file_content` (`string`, optional): The file content of the source logo file. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `logo_file_name` (`string`, optional): The filename of the source logo file, the file extension is mandatory: 'file.png' and not 'file'. Example: logo.png
- `logo_position` (`string`, optional): Set the position of the logo. One of: Top, Centre. Example: Top. One of: `Top`, `Centre`.
- `resolution` (`integer`, optional): Set the QR code border image resolution (dpi) Example: 96
- `size_mode` (`string`, optional): Set the QR auto size mode, use 'Nearest' to assure QR code readability. One of: None, Nearest, Fixed, Interpolation. Example: Nearest. One of: `None`, `Nearest`, `Fixed`, `Interpolation`.
- `text_encoding_type` (`string`, optional): Set the QR code text encoding type. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: Default. One of: `Default`, `Latin1`, `BigEndianUnicode`, `UTF16`, `UTF8`, `UTF7`, `ASCII`.
- `visible_border` (`boolean`, optional): Set whether the QR code border is visible. Example: true
- `width` (`integer`, optional): Set the QR code width (pixels). Example: 88

Example input: `{"barcode_data":"<barcode_data>","barcode_image_format":"PNG"}`

### `encodian_qr_codes_read`

Read QR Codes from Document · Write

Read the QR codes in a PDF or Word document.
Returns qrCodes, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the decoded values. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `barcode_read_confidence` (`string`, optional): Set the confidence level for barcode detection. One of: Low, Medium, High. Example: Medium. One of: `Low`, `Medium`, `High`.
- `barcode_read_quality` (`string`, optional): Controls barcode detection quality. Higher settings may improve recognition but reduce performance. One of: Normal, High, Low, Max. Example: Normal. One of: `Normal`, `High`, `Low`, `Max`.
- `barcode_remove_control_chars` (`boolean`, optional): Set whether recognised control characters should be removed. Example: true
- `end_page` (`integer`, optional): Set the page number to end reading on. Example: 2
- `file_type` (`string`, optional): Select the source document format. One of: PDF, DOCX. Example: PDF. One of: `PDF`, `DOCX`.
- `start_page` (`integer`, optional): Set the page number to begin reading from. Example: 1

Example input: `{"file_content":"<file_content>"}`

### `encodian_text_email_addresses_extract`

Extract Email Addresses from Text · Write

Find every email address in a text.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns an array of addresses. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `regex` (`string`, required): The default regular expression used for extraction. Example: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}
- `text` (`string`, required): The text from which email addresses are to be extracted. Example: Contact sales@acme.com or visit https://acme.com for details.

Example input: `{"regex":"<regex>","text":"<text>"}`

### `encodian_text_regex_search`

Search Text with Regex · Write

Search a text with a regular expression and return the matches (and groups).
Returns matches, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the matches. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `query` (`string`, required): The regex query to use to find matches in the string provided. Example: \d{4}
- `text` (`string`, required): The text to search with the regex string provided. Example: Contact sales@acme.com or visit https://acme.com for details.
- `ecma_script` (`boolean`, optional): Enables ECMAScript-compliant behavior for the expression. This value can be used only in conjunction with the IgnoreCase and Multiline options. Disabled by default. Example: false
- `explicit_capture` (`boolean`, optional): Specifies that the only valid captures are explicitly named or numbered groups of the form, disabled by default. Example: false
- `ignore_case` (`boolean`, optional): Specifies case-insensitive matching, disabled by default. Example: false
- `ignore_whitespace` (`boolean`, optional): Eliminates unescaped white space from the pattern and enables comments marked with #, disabled by default. Example: false
- `multiline` (`boolean`, optional): Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string, disabled by default. Example: false
- `return_groups` (`boolean`, optional): Specifies that the search will return match groups rather than match values. Example: false
- `right_to_left` (`boolean`, optional): Specifies that the search will be from right to left instead of from left to right, disabled by default. Example: false
- `singleline` (`boolean`, optional): Specifies single-line mode. Changes the meaning of the dot (.) so it matches every character (instead of every character except \n), disabled by default. Example: false

Example input: `{"query":"<query>","text":"<text>"}`

### `encodian_text_to_pdf_convert`

Convert Text to PDF · Write

Convert plain text (inline or a text file) to a PDF document.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `output_filename` (`string`, required): File name for the output file, including its extension. Example: output.pdf
- `file_content` (`string`, optional): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `text_data` (`string`, optional): Optional - Please provide either the text data which will be converted to a PDF document or The file content of the source file and source filename. Example: Meeting notes for 1 March 2026.
- `text_encoding_type` (`string`, optional): The encoding type used for text conversion. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: Default. One of: `Default`, `Latin1`, `BigEndianUnicode`, `UTF16`, `UTF8`, `UTF7`, `ASCII`.

Example input: `{"file_name":"<file_name>","output_filename":"<output_filename>"}`

### `encodian_text_urls_extract`

Extract URLs from Text · Write

Find every URL in a text.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns an array of URLs. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `regex` (`string`, required): The default regular expression used for extraction. Example: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}
- `text` (`string`, required): The text from which URL's are to be extracted. Example: Contact sales@acme.com or visit https://acme.com for details.

Example input: `{"regex":"<regex>","text":"<text>"}`

### `encodian_time_zone_convert`

Convert Time Zone · Write

Convert a date and time from one time zone to another (Windows time zone names).
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Returns the converted date. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): The date and time value to convert. Example: 2026-03-01T09:00:00Z
- `new_time_zone` (`string`, required): Set the new time zone. Example: GMTStandardTime. One of: `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`.
- `current_time_zone` (`string`, optional): Set the current time zone. Example: EasternStandardTime. One of: `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`.

Example input: `{"date":"<date>","new_time_zone":"Default"}`

### `encodian_word_documents_compare`

Compare Word Documents · Write

Compare two Word documents and return a document with the differences as tracked changes.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content_one` (`string`, required): The first Word document's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_content_two` (`string`, required): The second Word document's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `author` (`string`, optional): Set the name of the author used to denote differences in the output document. Example: Jane Doe
- `case_insensitive` (`boolean`, optional): Specifies whether to compare differences in documents as case insensitive. Example: false
- `ignore_comments` (`boolean`, optional): Specifies whether to compare differences in comments. Example: false
- `ignore_fields` (`boolean`, optional): Specifies whether to compare differences in fields. By default fields. Example: false
- `ignore_footnotes` (`boolean`, optional): Specifies whether to compare differences in footnotes and endnotes. Example: false
- `ignore_formatting` (`boolean`, optional): Specifies whether to ignore document formatting differences. Example: false
- `ignore_headers_and_footers` (`boolean`, optional): Specifies whether to compare differences in the data contained within headers and footers. Example: false
- `ignore_tables` (`boolean`, optional): Specifies whether to compare the differences in data contained in tables. Example: false
- `ignore_textboxes` (`boolean`, optional): Specifies whether to compare differences in the data contained within text boxes. Example: false

Example input: `{"file_content_one":"<file_content_one>","file_content_two":"<file_content_two>"}`

### `encodian_word_secure`

Secure Word Document · Write

Protect a Word document with a password and an editing restriction.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `password` (`string`, optional): Set the password used to protect the Microsoft Word document. Example: S3cret!pass
- `secure_on_open` (`boolean`, optional): Set whether a password should be required to open the Microsoft Word document. Example: false
- `secure_on_open_password` (`string`, optional): Set the password used to open the Microsoft Word document. Example: S3cret!pass
- `word_protection_type` (`string`, optional): Set the protection type for the Microsoft Word document. One of: AllowComments, AllowFormFields, AllowRevisions, ReadOnly, NoProtection. Example: NoProtection. One of: `AllowComments`, `AllowFormFields`, `AllowRevisions`, `ReadOnly`, `NoProtection`.

Example input: `{"file_content":"<file_content>","file_name":"<file_name>"}`

### `encodian_word_template_populate`

Populate Word Template · Write

Fill a Word template's merge fields and repeating sections from JSON data.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `document_data` (`string`, required): The JSON data to populate the Microsoft Word Document with. Example: {"customer": {"name": "Jane Doe"}}
- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `population_options` (`string`, required): Sets the behaviour of the population engine. One of: Default, AllowMissingMembers, ClearEmptyParagraphs, InlineErrors. Example: Default. One of: `Default`, `AllowMissingMembers`, `ClearEmptyParagraphs`, `InlineErrors`.
- `allow_missing_members` (`boolean`, optional): Sets the engine to allow missing values within the 'Document Data'. Example: false
- `date_time_format` (`string`, optional): Set one or more specfic formats for parsing DateTime values. Example: yyyy-MM-dd
- `inline_error_messages` (`boolean`, optional): Produces errors within the resultant document as opposed to rejecting the request with a HTTP 4 error. Example: false
- `json_parse_mode` (`string`, optional): Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) One of: Standard, Strict. Example: Standard. One of: `Standard`, `Strict`.
- `remove_empty_paragraphs` (`boolean`, optional): Sets the engine to automatically removes any empty paragraphs upon execution. Example: false
- `timezone` (`string`, optional): Set a specific time zone for date and time processing. Example: UTC. One of: `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`.

Example input: `{"document_data":"<document_data>","file_content":"<file_content>","population_options":"Default"}`

### `encodian_word_text_extract`

Extract Text from Word · Write

Extract the text of a Word document, optionally for a page range.
Returns text, HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus.
Returns the text. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `accept_changes` (`boolean`, optional): Set whether tracked changes should be accepted prior to extracting text from the the Microsoft Word file. Example: true
- `end_page` (`integer`, optional): Sets the page number to end text layer extraction from. The default value is set to the last page of the Microsoft Word document provided. Example: 2
- `remove_comments` (`boolean`, optional): Set whether comments should be removed prior to extracting text from the the Microsoft Word file. Example: true
- `remove_headers_and_footers` (`boolean`, optional): Set whether headers and footers should be removed from the the Microsoft Word file. Example: true
- `start_page` (`integer`, optional): Sets the page number to begin text layer extraction from. Example: 1

Example input: `{"file_content":"<file_content>"}`

### `encodian_word_text_replace`

Replace Text in Word · Write

Find and replace phrases in a Word document.
Returns HttpStatusCode, HttpStatusMessage, OperationId, Errors, OperationStatus, Filename, FileContent.
Returns the processed file as base64 fileContent with its filename. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `file_content` (`string`, required): The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
- `file_name` (`string`, required): Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
- `phrases` (`array`, required): The collection of text phrases to search for and replace. Example: [{"searchText": "{{name}}", "replacementText": "Jane Doe"}]

Example input: `{"file_content":"<file_content>","file_name":"<file_name>","phrases":[{"searchText":"{{name}}","replacementText":"Jane Doe"}]}`

### `encodian_xml_to_json_convert`

Convert XML to JSON · Write

Convert an XML string to JSON.
Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus.
Use encodian_json_to_xml_convert for the reverse. Each call uses Encodian Flowr credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `xml` (`string`, required): The XML to convert to JSON. Example: <order><id>1042</id></order>
- `omit_root_object` (`boolean`, optional): Set whether the root object should be omitted. Example: false

Example input: `{"xml":"<xml>"}`

## Related

Other Files & Documents connectors ([all 76](/agentkit/connectors/?category=files-documents)):

- [Notion](/agentkit/connectors/notion/): Scalekit connector, OAuth, 51 tools
- [Google Sheets](/agentkit/connectors/googlesheets/): Scalekit connector, OAuth, 48 tools
- [Google Drive](/agentkit/connectors/googledrive/): Scalekit connector, OAuth, 47 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
