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.
- Tools
- 60
- What they doRead · write · destructive
- 1 · 59 · 01 read59 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Encodian connection
In AgentKit > Connections, create an Encodian connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'encodian'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'encodian_subscription_status_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "encodian"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="encodian_subscription_status_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Encodian credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolencodian_subscription_status_getGet the Encodian Flowr subscription's status, plan, credits used and credits remaining.Read-onlyGet Subscription Status
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.
Inputs
This tool takes no inputs.
encodian_ai_invoice_processExtract structured invoice data (vendor, totals, line items, dates) from an invoice PDF or image.WriteExtract Invoice Data (AI)
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
date_formatstring- 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_modelstring- Set the Prebuilt Model to be used within the Azure service. Example: Contractone of
ContractHealthInsuranceCardUSIDDocumentInvoiceReceiptBankCheckUsBankStatementUSCreditCardMarriageCertificateUSMortgage1003Mortgage1004Mortgage1005Mortgage1008MortgageClosingDisclosurePayStubUSTaxUSTaxW2TaxW4Tax1095ATax1095CTax1098Tax1098ETax1098TTax1099ATax1099BTax1099CTax1099CAPTax1099ComboTax1099DIVTax1099GTax1099HTax1099INTTax1099KTax1099LSTax1099LTCTax1099MISCTax1099NECTax1099OIDTax1099PATRTax1099QTax1099QATax1099RTax1099STax1099SATax1099SBTax1099SSATax1040Tax1040Schedule1Tax1040Schedule2Tax1040Schedule3Tax1040Schedule8812Tax1040ScheduleATax1040ScheduleBTax1040ScheduleCTax1040ScheduleDTax1040ScheduleETax1040ScheduleEICTax1040ScheduleFTax1040ScheduleHTax1040ScheduleJTax1040ScheduleRTax1040ScheduleSETax1040Senior query_fieldsstring- A comma separated list of query fields to search for. Example: []
remove_new_linesboolean- Remove newlines in the data returned. Example: false
encodian_ai_prompt_runRun a prompt against an AI model through Encodian and return the response text.WriteRun AI Prompt
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.
Inputs
modelstringrequired- Select the Open AI model. One of: GPT_4_1, GPT_4_1_mini, o4_mini, GPT_5_4. Example: GPT_4_1_minione of
GPT_4_1GPT_4_1_minio4_miniGPT_5_4 promptstringrequired- The prompt for processing the 'Text' value provided. Example: Summarise the following text in two sentences.
contextstring- Optional - Sets context and rules for the conversation. Example: []
conversationstring- Optional - A JSON representation of the Open AI conversation for the associated chat session. Example: []
frequency_penaltynumber- 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_tokensinteger- Set the maximum limit for the number of tokens that can be generated for output tokens. Example: 10
presence_penaltynumber- 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_effortstring- 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: Lowone of
LowMediumHigh temperaturenumber- 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
encodian_ai_receipt_processExtract structured receipt data (merchant, totals, items, date) from a receipt image or PDF.WriteExtract Receipt Data (AI)
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
date_formatstring- 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_modelstring- Set the Prebuilt Model to be used within the Azure service. Example: Contractone of
ContractHealthInsuranceCardUSIDDocumentInvoiceReceiptBankCheckUsBankStatementUSCreditCardMarriageCertificateUSMortgage1003Mortgage1004Mortgage1005Mortgage1008MortgageClosingDisclosurePayStubUSTaxUSTaxW2TaxW4Tax1095ATax1095CTax1098Tax1098ETax1098TTax1099ATax1099BTax1099CTax1099CAPTax1099ComboTax1099DIVTax1099GTax1099HTax1099INTTax1099KTax1099LSTax1099LTCTax1099MISCTax1099NECTax1099OIDTax1099PATRTax1099QTax1099QATax1099RTax1099STax1099SATax1099SBTax1099SSATax1040Tax1040Schedule1Tax1040Schedule2Tax1040Schedule3Tax1040Schedule8812Tax1040ScheduleATax1040ScheduleBTax1040ScheduleCTax1040ScheduleDTax1040ScheduleETax1040ScheduleEICTax1040ScheduleFTax1040ScheduleHTax1040ScheduleJTax1040ScheduleRTax1040ScheduleSETax1040Senior query_fieldsstring- A comma separated list of query fields to search for. Example: []
remove_new_linesboolean- Remove newlines in the data returned. Example: false
encodian_ai_text_translateTranslate text into another language with Encodian's AI translation.WriteTranslate Text (AI)
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.
Inputs
target_languagestringrequired- The language to convert the source 'Text' value to. Example: Frenchone of
AfrikaansAlbanianAmharicArabicArmenianAssameseAzerbaijaniLatinBanglaBashkirBasqueBhojpuriBodoBosnianLatinBulgarianCantoneseTraditionalCatalanChineseLiteraryChineseSimplifiedChineseTraditionalChiShonaCroatianCzechDanishDariDivehiDogriDutchEnglishEstonianFaroeseFijianFilipinoFinnishFrenchFrenchCanadianGalicianGeorgianGermanGreekGujaratiHaitianCreoleHausaHebrewHindiHmongDawLatinHungarianIcelandicIgboIndonesianInuinnaqtunInuktitutInuktitutLatinIrishItalianJapaneseKannadaKashmiriKazakhKhmerKinyarwandaKlingonKlingonPlqaDKonkaniKoreanKurdishCentralKurdishNorthernKyrgyzCyrillicLaoLatvianLithuanianLingalaLowerSorbianLugandaMacedonianMaithiliMalagasyMalayLatinMalayalamMalteseMaoriMarathiMongolianCyrillicMongolianTraditionalMyanmarNepaliNorwegianNyanjaOdiaPashtoPersianPolishPortugueseBrazilPortuguesePortugalPunjabiQueretaroOtomiRomanianRundiRussianSamoanLatinSerbianCyrillicSerbianLatinSesothoSesothoSaLeboaSetswanaSindhiSinhalaSlovakSlovenianSomaliArabicSpanishSwahiliLatinSwedishTahitianTamilTatarLatinTeluguThaiTibetanTigrinyaTonganTurkishTurkmenLatinUkrainianUpperSorbianUrduUyghurArabicUzbekLatinVietnameseWelshXhosaYorubaYucatecMayaZulu textstringrequired- The text to translate. Example: Contact sales@acme.com or visit https://acme.com for details.
formatstring- Set the format of the 'Text' value. One of: HTML, Text. Example: Textone of
HTMLText profanity_actionstring- Define how to handle profanity detected within the 'Text' value. One of: Delete, Keep, Replace. Example: Keepone of
DeleteKeepReplace profanity_replacestring- 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: Asteriskone of
AsteriskTag source_languagestring- The language of the source text, select 'AUTO' to automatically detect. Example: Englishone of
AUTOAfrikaansAlbanianAmharicArabicArmenianAssameseAzerbaijaniLatinBanglaBashkirBasqueBhojpuriBodoBosnianLatinBulgarianCantoneseTraditionalCatalanChineseLiteraryChineseSimplifiedChineseTraditionalChiShonaCroatianCzechDanishDariDivehiDogriDutchEnglishEstonianFaroeseFijianFilipinoFinnishFrenchFrenchCanadianGalicianGeorgianGermanGreekGujaratiHaitianCreoleHausaHebrewHindiHmongDawLatinHungarianIcelandicIgboIndonesianInuinnaqtunInuktitutInuktitutLatinIrishItalianJapaneseKannadaKashmiriKazakhKhmerKinyarwandaKlingonKlingonPlqaDKonkaniKoreanKurdishCentralKurdishNorthernKyrgyzCyrillicLaoLatvianLithuanianLingalaLowerSorbianLugandaMacedonianMaithiliMalagasyMalayLatinMalayalamMalteseMaoriMarathiMongolianCyrillicMongolianTraditionalMyanmarNepaliNorwegianNyanjaOdiaPashtoPersianPolishPortugueseBrazilPortuguesePortugalPunjabiQueretaroOtomiRomanianRundiRussianSamoanLatinSerbianCyrillicSerbianLatinSesothoSesothoSaLeboaSetswanaSindhiSinhalaSlovakSlovenianSomaliArabicSpanishSwahiliLatinSwedishTahitianTamilTatarLatinTeluguThaiTibetanTigrinyaTonganTurkishTurkmenLatinUkrainianUpperSorbianUrduUyghurArabicUzbekLatinVietnameseWelshXhosaYorubaYucatecMayaZulu
encodian_barcode_createCreate a barcode image of a chosen type (Code 128, EAN-13 and others) from data.WriteCreate Barcode
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.
Inputs
code_text_encodingstringrequired- Set Encoding of the text. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: UTF8one of
DefaultLatin1BigEndianUnicodeUTF16UTF8UTF7ASCII dot_codemaskintegerrequired- Set the mask value for DotCode barcodes. Example: -1
aspect_rationumber- Set the aspect ratio of the barcode. Example: 1
australian_post_encoding_tablestring- Set encoding table type for an Australian Post barcode. One of: CTable, NTable, Other. Example: Otherone of
CTableNTableOther australian_post_short_bar_heightinteger- Set short bar height for an Australian Post barcode (pixels). Example: 120
aztec_error_levelinteger- Set the error level protect for Aztec barcodes (value between 10-95) Example: 10
aztec_symbol_modestring- Set the Aztec symbol mode for Aztec barcodes. One of: Auto, Compact, FullRange, Rune. Example: Autoone of
AutoCompactFullRangeRune back_colorstring- Set the barcode back color of the barcode. (HTML color format). Example: White
bar_colorstring- Set the color of the barcode bars (HTML color format). Example: Black
bar_heightinteger- Set the height of the barcode bars (pixels). Example: 10
barcode_caption_above_fontstring- Set the font for the caption above the barcode. Example: example
barcode_caption_above_font_alignmentstring- Set the alignment of the font applied to the caption text above the barcode. One of: Left, Centre, Right. Example: Leftone of
LeftCentreRight barcode_caption_above_font_colourstring- Set the color of the font applied to the caption text above the barcode. Example: AliceBlueone of
AliceBlueAntiqueWhiteAquaAquamarineAzureBeigeBisqueBlackBlanchedAlmondBlueBlueVioletBrownBurlyWoodCadetBlueChartreuseChocolateCoralCornflowerBlueCornsilkCrimsonCyanDarkBlueDarkCyanDarkGoldenrodDarkGrayDarkGreenDarkKhakiDarkMagentaDarkOliveGreenDarkOrangeDarkOrchidDarkRedDarkSalmonDarkSeaGreenDarkSlateBlueDarkSlateGrayDarkTurquoiseDarkVioletDeepPinkDeepSkyBlueDimGrayDodgerBlueFirebrickFloralWhiteForestGreenFuchsiaGainsboroGhostWhiteGoldGoldenrodGrayGreenGreenYellowHoneydewHotPinkIndianRedIndigoIvoryKhakiLavenderLavenderBlushLawnGreenLemonChiffonLightBlueLightCoralLightCyanLightGoldenrodYellowLightGrayLightGreenLightPinkLightSalmonLightSeaGreenLightSkyBlueLightSlateGrayLightSteelBlueLightYellowLimeLimeGreenLinenMagentaMaroonMediumAquamarineMediumBlueMediumOrchidMediumPurpleMediumSeaGreenMediumSlateBlueMediumSpringGreenMediumTurquoiseMediumVioletRedMidnightBlueMintCreamMistyRoseMoccasinNavajoWhiteNavyOldLaceOliveOliveDrabOrangeOrangeRedOrchidPaleGoldenrodPaleGreenPaleTurquoisePaleVioletRedPapayaWhipPeachPuffPeruPinkPlumPowderBluePurpleRedRosyBrownRoyalBlueSaddleBrownSalmonSandyBrownSeaGreenSeaShellSiennaSilverSkyBlueSlateBlueSlateGraySnowSpringGreenSteelBlueTanTealThistleTomatoTransparentTurquoiseVioletWheatWhiteWhiteSmokeYellowYellowGreen barcode_caption_above_font_sizenumber- Set the size of the font applied to the caption text above the barcode. Example: 25
barcode_caption_above_font_stylestring- Set the style of the font applied to the caption text above the barcode. One of: Regular, Bold, Italic, Underline, Strikeout. Example: Regularone of
RegularBoldItalicUnderlineStrikeout barcode_caption_below_fontstring- Set the font for the caption below the barcode. Example: example
barcode_caption_below_font_alignmentstring- Set the alignment of the font applied to the caption text below the barcode. One of: Left, Centre, Right. Example: Leftone of
LeftCentreRight barcode_caption_below_font_colourstring- Set the color of the font applied to the caption text below the barcode. Example: AliceBlueone of
AliceBlueAntiqueWhiteAquaAquamarineAzureBeigeBisqueBlackBlanchedAlmondBlueBlueVioletBrownBurlyWoodCadetBlueChartreuseChocolateCoralCornflowerBlueCornsilkCrimsonCyanDarkBlueDarkCyanDarkGoldenrodDarkGrayDarkGreenDarkKhakiDarkMagentaDarkOliveGreenDarkOrangeDarkOrchidDarkRedDarkSalmonDarkSeaGreenDarkSlateBlueDarkSlateGrayDarkTurquoiseDarkVioletDeepPinkDeepSkyBlueDimGrayDodgerBlueFirebrickFloralWhiteForestGreenFuchsiaGainsboroGhostWhiteGoldGoldenrodGrayGreenGreenYellowHoneydewHotPinkIndianRedIndigoIvoryKhakiLavenderLavenderBlushLawnGreenLemonChiffonLightBlueLightCoralLightCyanLightGoldenrodYellowLightGrayLightGreenLightPinkLightSalmonLightSeaGreenLightSkyBlueLightSlateGrayLightSteelBlueLightYellowLimeLimeGreenLinenMagentaMaroonMediumAquamarineMediumBlueMediumOrchidMediumPurpleMediumSeaGreenMediumSlateBlueMediumSpringGreenMediumTurquoiseMediumVioletRedMidnightBlueMintCreamMistyRoseMoccasinNavajoWhiteNavyOldLaceOliveOliveDrabOrangeOrangeRedOrchidPaleGoldenrodPaleGreenPaleTurquoisePaleVioletRedPapayaWhipPeachPuffPeruPinkPlumPowderBluePurpleRedRosyBrownRoyalBlueSaddleBrownSalmonSandyBrownSeaGreenSeaShellSiennaSilverSkyBlueSlateBlueSlateGraySnowSpringGreenSteelBlueTanTealThistleTomatoTransparentTurquoiseVioletWheatWhiteWhiteSmokeYellowYellowGreen barcode_caption_below_font_sizenumber- Set the size of the font applied to the caption text below the barcode. Example: 25
barcode_caption_below_font_stylestring- Set the style of the font applied to the caption text below the barcode. One of: Regular, Bold, Italic, Underline, Strikeout. Example: Regularone of
RegularBoldItalicUnderlineStrikeout barcode_datastring- Barcode Data. Example: https://acme.com
barcode_image_formatstring- Barcode Image Format. One of: PNG, JPG, SVG, BMP, TIFF, GIF. Example: PNGone of
PNGJPGSVGBMPTIFFGIF barcode_typestring- Set the type of barcode to be produced. Example: AustraliaPostone of
AustraliaPostAztecCodabarCodablockFCode11Code39StandardCode39ExtendedCode128Code16KDatabarExpandedDatabarExpandedStackedDatabarLimitedDatabarOmniDirectionalDatabarStackedDatabarStackedOmniDirectionalDatabarTruncatedDataMatrixDotCodeEAN8EAN13GS1Code128GS1CodablockFInterleaved2of5ISBNISMNISSNITF6ITF14MaxiCodePdf417PlanetPostnetStandard2of5UPCAUpcaGs1Code128CouponUpcaGs1DatabarCouponUPCE barcode_type_parameterstring- Set the barcode type. Example: AustraliaPostone of
AustraliaPostAztecCodabarCodablockFCode11Code39StandardCode39ExtendedCode128Code16KDatabarExpandedDatabarExpandedStackedDatabarLimitedDatabarOmniDirectionalDatabarStackedDatabarStackedOmniDirectionalDatabarTruncatedDataMatrixDotCodeEAN8EAN13GS1Code128GS1CodablockFInterleaved2of5ISBNISMNISSNITF6ITF14MaxiCodePdf417PlanetPostnetStandard2of5UPCAUpcaGs1Code128CouponUpcaGs1DatabarCouponUPCE barcode_value_text_locationstring- Set the location of the barcode value text. One of: None, Above, Below. Example: Belowone of
NoneAboveBelow border_colorstring- Set the barcode border color (HTML color format) Example: Black
border_stylestring- Set the barcode code border style. One of: Dash, DashDot, DashDotDot, Dot, Solid. Example: Dashone of
DashDashDotDashDotDotDotSolid border_visibleboolean- Set whether the barcode border is visible or not. Example: true
border_widthinteger- Set width of the barcode border (pixels). Example: 12345
caption_abovestring- Set the caption text above the barcode. Example: Order 1042
caption_belowstring- Set the caption text below the barcode. Example: acme.com
codabar_checksum_modestring- Set the checksum mode for Codabar barcodes. One of: Mod10, Mod16. Example: Mod16one of
Mod10Mod16 codabar_start_symbolstring- Set the start symbol for Codabar barcodes. One of: A, B, C, D. Example: Aone of
ABCD codabar_stop_symbolstring- Set the stop symbol for Codabar barcodes. One of: A, B, C, D. Example: Bone of
ABCD code16_k_quiet_zone_left_coefinteger- Set the size of the left quiet zone as a multiple of the xDimension for Code16K barcodes. Example: 10
code16_k_quiet_zone_right_coefinteger- Set the size of the right quiet zone as a multiple of the xDimension for Code16K barcodes. Example: 1
columnsinteger- Set the number of columns. Example: 10
data_matrix_eccstring- Set the DataMatrix ECC type for DataMatrix barcodes. One of: EccAuto, Ecc000, Ecc050, Ecc080, Ecc100, Ecc140, Ecc200. Example: EccAutoone of
EccAutoEcc000Ecc050Ecc080Ecc100Ecc140Ecc200 data_matrix_encode_modestring- Set encoding mode for DataMatrix barcodes. One of: Auto, ASCII, Bytes, C40, Text, EDIFACT, ANSIX12, ExtendedCodetext, Extended, Base256, Binary, ECI. Example: Autoone of
AutoASCIIBytesC40TextEDIFACTANSIX12ExtendedCodetextExtendedBase256BinaryECI filled_barsboolean- Set whether the barcode bars are a filled. Example: true
heightinteger- Set the barcode height (pixels). Example: 10
itf_border_thicknessinteger- Set the border thickness for ITF barcodes (pt). Example: 1
itf_border_typestring- Set the border type for ITF barcodes. One of: None, Frame, Bar, FrameOut, BarOut. Example: Barone of
NoneFrameBarFrameOutBarOut maxi_code_encode_modeinteger- Set the encode mode for Maxi Code barcodes (value between 2 and 6). Example: 4
padding_bottominteger- Set bottom padding of the barcode (pixels). Example: 10
padding_leftinteger- Set left padding of the barcode (pixels). Example: 10
padding_rightinteger- Set right padding of the barcode (pixels). Example: 10
padding_topinteger- Set top padding of the barcode (pixels). Example: 10
pdf417_compaction_modestring- Set the compaction mode for Pdf417 barcodes. One of: Auto, Text, Numeric, Binary. Example: Autoone of
AutoTextNumericBinary pdf417_error_levelstring- Set the error level for Pdf417 barcodes. One of: Level0, Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8. Example: Level8one of
Level0Level1Level2Level3Level4Level5Level6Level7Level8 pdf417_macro_file_idinteger- Set the macro file ID for Pdf417 barcodes. Example: 1
pdf417_macro_segment_idinteger- Set the macro segment ID for Pdf417 barcodes. Example: 1
pdf417_macro_segments_countinteger- Set macro segment count for Pdf417 barcodes. Example: 1
pdf417_truncateboolean- Set whether the Pdf417 barcode is truncated to save space. Example: false
postal_short_bar_heightinteger- Set the short bar height of Postal barcodes. Example: 20
quiet_zone_coefinteger- Set the quiet zone coefficient as a mulitple of the X Dimension for ITF barcodes. Example: 10
resolutioninteger- Set the barcode code border image resolution (dpi) Example: 10
rotationanglenumber- Set the barcode rotation angle measure in degrees, for best results use 0, 90, 180 or 270. Example: 0
rowsinteger- Set the number of rows. Example: 10
size_modestring- Set the barcode auto sizing mode. One of: None, Nearest, Fixed, Interpolation. Example: Noneone of
NoneNearestFixedInterpolation supplement_datastring- Set the supplement data that follows the barcode. Example: example
supplement_spaceinteger- Set the space between the main barcode and supplement barcode. Example: 0
wide_narrow_rationumber- Set the ratio of wide bars to narrow bars (default 3 i.e. Wide bars are 3 times wider than narrow bars). Example: 3
widthinteger- Set the barcode width (pixels). Example: 12345
x_dimensionnumber- Set minimum width of the barcode bars (pixels). Example: 10
encodian_csv_parseParse a CSV file into JSON rows.WriteParse CSV
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
csv_column_headersstring- Manually set the column headers for the CSV data (Column delimited: Column 1, Column 2, etc. Example: example
delimiterstring- Set the CSV delimiter, the default value is a comma: ','. Example: ,
encodingstring- Set the character encoding used to process the CSV file. One of: ASCII, ISO88591, ISO88592, Latin1, UTF8. Example: ISO88591one of
ASCIIISO88591ISO88592Latin1UTF8 skip_first_lineboolean- Skip the first line of the CSV file, set to 'Yes' if your CSV document contains column headers. Example: true
encodian_date_calculateAdd or subtract an interval of days, weeks, months or years from a date, optionally skipping given days.WriteCalculate Date
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.
Inputs
datestringrequired- The date value to calculate. Example: 2026-03-01T09:00:00Z
intervalintegerrequired- Set amount of time to add or subtract from the 'Date' value provided. Example: 5
measurementstringrequired- Set the time measurement used for the calculation. One of: Ticks, Milliseconds, Seconds, Minutes, Hours, Days, Months, Years. Example: Daysone of
TicksMillisecondsSecondsMinutesHoursDaysMonthsYears operationstringrequired- Set the operation type, either add or subtract. One of: Add, Subtract. Example: Addone of
AddSubtract dates_to_excludestring- 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_excludestring- Specify the days to be excluded from the calculation as a comma-delimited list, for example: Saturday, Sunday. Example: []
encodian_date_formatFormat a date value with a .NET date format string.WriteFormat Date
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.
Inputs
datestringrequired- The date value to format. Example: 2026-03-01T09:00:00Z
formatstringrequired- Set the date format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings. Example: dd MMMM yyyy
encodian_email_address_validateCheck that an email address is syntactically valid.WriteValidate Email Address
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.
Inputs
email_addressstringrequired- The email address to verify. Example: jane@example.com
regexstringrequired- The regular expression used for validation. Example: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}
encodian_email_info_getExtract metadata (sender, recipients, subject, dates, body) from an .eml or .msg email file.WriteExtract Email Metadata
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
encodian_excel_rows_addAdd rows from JSON data to an Excel worksheet or table.WriteAdd Rows to Excel
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
json_datastringrequired- The JSON dataset to be processed and added as rows to the Excel file provided. Example: [{"Name": "Jane", "Total": 120}]
convert_numeric_and_dateboolean- Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date'. Example: false
date_formatstring- 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_titlesboolean- Ignores titles of JSON attributes when converting JSON to Excel. Example: true
ignore_nullsboolean- Ignore JSON properties which contain null values. Example: false
insertion_columninteger- The column number after which the data provided will be inserted. Example: 10
insertion_rowinteger- The row number after which the data provided will be inserted. Example: 10
numeric_formatstring- Set the numeric format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings. Example: 0.00
table_namestring- 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_namestring- Specify the name of a specific worksheet. Example: Sheet1
encodian_excel_rows_getExtract rows from an Excel worksheet as JSON, with row and column limits.WriteExtract Rows from Excel
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
always_export_as_json_objectboolean- 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_rowsboolean- Set whether empty rows should be excluded from the export. Example: true
exclude_hidden_columnsboolean- Set whether hidden columns should be excluded from the export. Example: false
exclude_hidden_rowsboolean- Set whether hidden rows should be excluded from the export. Example: false
export_empty_cellsboolean- Set whether empty cells should be exported. Example: true
export_values_as_textboolean- Set whether values should be exported as text, i.e. a number would be exported as "value":"3". Example: false
first_columninteger- Set the number of the first column to be exported. Example: 10
first_rowinteger- Set the number of the first row to be exported. Example: 10
has_header_rowboolean- Set whether the first row specified is a header row. Example: true
hyperlink_formatstring- Set how Hyperlinks should be exported. One of: Title, URL, HTML. Example: Titleone of
TitleURLHTML last_columninteger- Set the number of the last column to be exported. Example: 10
last_rowinteger- Set the number of the last row to be rows to be exported. Example: 10
worksheet_namestring- Set the name of a specific worksheet to be exported. Example: Sheet1
encodian_excel_template_populateFill an Excel template's merge fields from JSON data.WritePopulate Excel Template
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
json_datastringrequired- The JSON data to populate the Microsoft Excel wookbook with. Example: [{"Name": "Jane", "Total": 120}]
allow_missing_membersboolean- Sets the engine to allow missing values within the 'JSON Data'. Example: true
calculate_workbookboolean- Automatically calculate formulas upon population. Example: true
date_time_formatstring- Set one or more specfic formats for parsing DateTime values. Example: yyyy-MM-dd
inline_error_messagesboolean- Produces errors within the resultant workbook as opposed to rejecting the request with a HTTP 4 error. Example: true
json_parse_modestring- Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) One of: Standard, Strict. Example: Standardone of
StandardStrict remove_empty_paragraphsboolean- Sets the engine to automatically removes any empty paragraphs upon execution. Example: true
use_excel_data_typesboolean- When enabled data is added to the workbook using corresponding Excel data types as opposed to a string data type. Example: true
encodian_file_to_pdf_convertConvert an Office document, image, email or other file to PDF or PDF/A.WriteConvert File to PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
generate_bookmarksboolean- Set whether bookmarks should be automatically created for Microsoft Word documents which are converted to PDF. Example: true
pdfa_complianceboolean- Set PDF/A Compliance option. Example: false
pdfa_compliance_levelstring- Set the PDF/A Compliance Level, the default value is PDF_A_2A. Example: PDF_A_2Aone of
PDF_A_1APDF_A_1BPDF_A_2APDF_A_3APDF_A_2BPDF_A_2UPDF_A_3BPDF_A_3Uv_1_3v_1_4v_1_5v_1_6v_1_7PDF_X_1APDF_X_3 remove_document_markupboolean- Set MS Office document comments and tracked changes removal option. Example: true
encodian_files_to_excel_mergeMerge several Excel or CSV files into one workbook.WriteMerge Excel Files
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.
Inputs
documentsarrayrequired- 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_formatstring- The format of the output excel file. One of: PDF, CSV, TIFF, XLSX, XLS, XLSB, XLSM. Example: XLSXone of
PDFCSVTIFFXLSXXLSXLSBXLSM output_filenamestring- File name for the output file, including its extension. Example: output.pdf
encodian_files_to_pdf_mergeMerge several files (PDF, Office, images) into one PDF, in the order given.WriteMerge Files to PDF
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.
Inputs
documentsarrayrequired- Files to merge, as a JSON array of objects with fileName (including extension) and base64 fileContent. Example: [{"fileName": "a.pdf", "fileContent": "JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}]
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
generate_bookmarksboolean- Generate a bookmark for each merged PDF document. Example: true
page_normalisationboolean- Set whether to normalise the page width/height to the dimensions of the first file. Example: false
pdfa_complianceboolean- Set PDF/A Compliance option. Example: false
pdfa_compliance_levelstring- Set the PDF/A Compliance Level, the default value is PDF_A_2A. Example: PDF_A_2Aone of
PDF_A_1APDF_A_1BPDF_A_2APDF_A_3APDF_A_2BPDF_A_2UPDF_A_3BPDF_A_3Uv_1_3v_1_4v_1_5v_1_6v_1_7PDF_X_1APDF_X_3 preserve_bookmarksboolean- Preserve bookmarks contained within each merged PDF document. Example: false
remove_document_markupboolean- Set MS Office document comments and tracked changes removal option. Example: false
encodian_files_to_word_mergeMerge several Word documents into one, in the order given.WriteMerge Files to Word
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.
Inputs
documentsarrayrequired- Files to merge, as a JSON array of objects with fileName (including extension) and base64 fileContent. Example: [{"fileName": "a.pdf", "fileContent": "JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK"}]
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
merge_contentboolean- Set whether the content from each file should also be merged, alongside the files. Example: false
quick_part_mappingstring- Set quick part data to be mapped from the first or last document, or removed. One of: First, Last, None. Example: Noneone of
FirstLastNone timezonestring- Set a specific time zone for date and time processing. Example: UTCone of
DefaultAUSCentralStandardTimeAUSEasternStandardTimeAfghanistanStandardTimeAlaskanStandardTimeAleutianStandardTimeAltaiStandardTimeArabStandardTimeArabianStandardTimeArabicStandardTimeArgentinaStandardTimeAstrakhanStandardTimeAtlanticStandardTimeAusCentralWStandardTimeAzerbaijanStandardTimeAzoresStandardTimeBahiaStandardTimeBangladeshStandardTimeBelarusStandardTimeBougainvilleStandardTimeCanadaCentralStandardTimeCapeVerdeStandardTimeCaucasusStandardTimeCenAustraliaStandardTimeCentralAmericaStandardTimeCentralAsiaStandardTimeCentralBrazilianStandardTimeCentralEuropeStandardTimeCentralEuropeanStandardTimeCentralPacificStandardTimeCentralStandardTimeCentralStandardTimeMexicoChathamIslandsStandardTimeChinaStandardTimeCubaStandardTimeDatelineStandardTimeEAfricaStandardTimeEAustraliaStandardTimeEEuropeStandardTimeESouthAmericaStandardTimeEasterIslandStandardTimeEasternStandardTimeEasternStandardTimeMexicoEgyptStandardTimeEkaterinburgStandardTimeFLEStandardTimeFijiStandardTimeGMTStandardTimeGTBStandardTimeGeorgianStandardTimeGreenlandStandardTimeGreenwichStandardTimeHaitiStandardTimeHawaiianStandardTimeIndiaStandardTimeIranStandardTimeIsraelStandardTimeJordanStandardTimeKaliningradStandardTimeKamchatkaStandardTimeKoreaStandardTimeLibyaStandardTimeLineIslandsStandardTimeLordHoweStandardTimeMagadanStandardTimeMagallanesStandardTimeMarquesasStandardTimeMauritiusStandardTimeMidAtlanticStandardTimeMiddleEastStandardTimeMontevideoStandardTimeMoroccoStandardTimeMountainStandardTimeMountainStandardTimeMexicoMyanmarStandardTimeNCentralAsiaStandardTimeNamibiaStandardTimeNepalStandardTimeNewZealandStandardTimeNewfoundlandStandardTimeNorfolkStandardTimeNorthAsiaEastStandardTimeNorthAsiaStandardTimeNorthKoreaStandardTimeOmskStandardTimePacificSAStandardTimePacificStandardTimePacificStandardTimeMexicoPakistanStandardTimeParaguayStandardTimeQyzylordaStandardTimeRomanceStandardTimeRussiaTimeZone10RussiaTimeZone11RussiaTimeZone3RussianStandardTimeSAEasternStandardTimeSAPacificStandardTimeSAWesternStandardTimeSEAsiaStandardTimeSaintPierreStandardTimeSakhalinStandardTimeSamoaStandardTimeSaoTomeStandardTimeSaratovStandardTimeSingaporeStandardTimeSouthAfricaStandardTimeSouthSudanStandardTimeSriLankaStandardTimeSudanStandardTimeSyriaStandardTimeTaipeiStandardTimeTasmaniaStandardTimeTocantinsStandardTimeTokyoStandardTimeTomskStandardTimeTongaStandardTimeTransbaikalStandardTimeTurkeyStandardTimeTurksAndCaicosStandardTimeUSEasternStandardTimeUSMountainStandardTimeUTCUTC02UTC08UTC09UTC11UTC12UTC13UlaanbaatarStandardTimeVenezuelaStandardTimeVladivostokStandardTimeVolgogradStandardTimeWAustraliaStandardTimeWCentralAfricaStandardTimeWEuropeStandardTimeWMongoliaStandardTimeWestAsiaStandardTimeWestBankStandardTimeWestPacificStandardTimeYakutskStandardTimeYukonStandardTime word_compliance_levelstring- Specify which OOXML specification will be used when saving in the DOCX format. One of: Ecma, Transitional, Strict. Example: Transitionalone of
EcmaTransitionalStrict
encodian_hash_createCompute a hash (MD5, SHA-1, SHA-256, SHA-512) of a value.WriteCreate Hash
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.
Inputs
datastringrequired- Provide the input data to be computed. Example: hello world
digest_algorithmstringrequired- Select the message digest algorithm. One of: SHA1, SHA256, SHA384, SHA512, MD5, RIPEMD160. Example: SHA256one of
SHA1SHA256SHA384SHA512MD5RIPEMD160 casestring- Set the case applied to the computed value. One of: Lower, Upper. Example: Lowerone of
LowerUpper crypto_input_data_typestring- Set the data format for the input data provided. One of: TEXT, HEX, BASE64, FILE. Example: TEXTone of
TEXTHEXBASE64FILE crypto_output_data_typestring- Set the data format for the hash code generated. One of: HASH, BASE64, HEX. Example: HASHone of
HASHBASE64HEX encodingstring- Select the encoding type. One of: UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode, Default. Example: ASCIIone of
UTF8UTF7UTF32ASCIIUnicodeBigEndianUnicodeDefault
encodian_html_table_parseParse a table in HTML (inline or a file) into JSON rows.WriteParse HTML Table
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.
Inputs
content_filterstring- Set that only table cells which match the specified type will be parsed. One of: All, DateTime, Integer, Currency, Decimal. Example: Allone of
AllDateTimeIntegerCurrencyDecimal file_contentstring- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
generate_headersboolean- When table header tags ( ) are not present, generate headers using the first row ( ) Example: false
htmlstring- Optional - The HTML to be parsed. Example: <table><tr><th>Name</th></tr><tr><td>Jane</td></tr></table>
quantity_filterinteger- Get the rows with the specified number of columns. Example: 10
table_idstring- Set the ID of the HTML table to parse, when more than one table is present within the HTML. Example: orders
table_indexinteger- 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
encodian_html_to_pdf_convertConvert HTML (inline, a URL or an HTML file) to a PDF document.WriteConvert HTML to PDF
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.
Inputs
encodingstringrequired- Set the encoding type for the HTML. One of: UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode. Example: UTF8one of
UTF8UTF7UTF32ASCIIUnicodeBigEndianUnicode file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
create_pdf_formboolean- Set whether the HTML content should be converted to a PDF form. Example: false
css_typestring- Set whether the standard or print style sheets should be used for HTML conversion. One of: Screen, Print. Example: Screenone of
ScreenPrint decode_html_databoolean- Set whether the data provided in the HTML Data field should be decoded. Example: true
delayinteger- Set the delay in milliseconds between the HTML being received and the conversion to allo time for JavaScript to load. Example: 2000
enable_bookmarksboolean- Enable or disable auto creation of PDF bookmarks. Example: true
enable_hyperlinksboolean- Enable or disable hyperlinks. Example: true
enable_java_scriptboolean- Enable or disable javascript. Example: true
file_contentstring- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
html_datastring- Optional - The HTML which will be converted to a PDF document. Example: <html><body><h1>Invoice 1042</h1></body></html>
html_urlstring- Optional - The web address to the web page which will be converted to a PDF document. Example: https://example.com/invoice.html
margin_bottomnumber- Set the bottom margin value (pixels) Example: 25
margin_leftnumber- Set the left margin value (pixels) Example: 25
margin_rightnumber- Set the right margin value (pixels) Example: 25
margin_topnumber- Set the top margin value (pixels) Example: 25
page_heightinteger- Set the page height value (pixels) Example: 0
page_orientationstring- Set page oprientation (Landscape or portrait). One of: Portrait, Landscape. Example: Portraitone of
PortraitLandscape page_sizestring- Set the page size for the output PDF document, A4 is the default size. Example: A4one of
DefaultA1A2A3A4A5A6B4B5EnvelopeDLExecutiveFolioLedgerLegalLetterQuartoStatementTabloidCustom page_widthinteger- Set the page width value (pixels) Example: 0
repeat_table_footerboolean- Set whether to repeat the table footer on every page break. The default value is true. Example: true
repeat_table_headerboolean- Set whether to repeat the table header on every page break. The default value is true. Example: true
split_imagesboolean- Set whether to split images. Example: false
split_text_linesboolean- Set whether to split text lines. Example: false
view_portstring- Set the viewport used to render the HTML. One of: Default, Mobile, Tablet, Laptop, LaptopL, FourK. Example: Defaultone of
DefaultMobileTabletLaptopLaptopLFourK
encodian_html_to_word_convertConvert HTML (inline, a URL or an HTML file) to a Word document.WriteConvert HTML to Word
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.
Inputs
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
decode_html_databoolean- Set whether the data provided in the HTML Data field should be decoded. Example: true
encodingstring- Set the encoding type for the HTML. One of: UTF8, UTF7, UTF32, ASCII, Unicode, BigEndianUnicode. Example: UTF8one of
UTF8UTF7UTF32ASCIIUnicodeBigEndianUnicode file_contentstring- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
html_datastring- Optional - The HTML which will be converted to a Word document. Example: <html><body><h1>Invoice 1042</h1></body></html>
html_urlstring- Optional - The web address to the web page which will be converted to a Word document. Example: https://example.com/invoice.html
margin_bottomnumber- 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_leftnumber- 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_rightnumber- 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_topnumber- 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_heightinteger- Set the page height value (pixels) Example: 0
page_orientationstring- Set page oprientation (Landscape or portrait). One of: Portrait, Landscape. Example: Portraitone of
PortraitLandscape page_sizestring- Set the page size for the output Word document, A4 is the default size. Example: A4one of
DefaultA1A2A3A4A5A6B4B5EnvelopeDLExecutiveFolioLedgerLegalLetterQuartoStatementTabloidCustom page_widthinteger- Set the page width value (pixels) Example: 0
word_compliance_levelstring- Set the compliance level applied to the HTML source during conversion. One of: Ecma, Transitional, Strict. Example: Ecmaone of
EcmaTransitionalStrict
encodian_image_compressReduce an image's file size.WriteCompress Image
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
image_typestringrequired- Select the image file format. One of: JPG, PNG. Example: JPGone of
JPGPNG compression_levelstring- Set the compression level where a higher level provides greater compression. One of: Default, Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8, Level9. Example: Defaultone of
DefaultLevel1Level2Level3Level4Level5Level6Level7Level8Level9
encodian_image_format_convertConvert an image to another format, such as PNG to JPG.WriteConvert Image Format
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.
Inputs
current_image_formatstringrequired- Select the current image file format. One of: BMP, GIF, JPG, PNG, TIF, HEIC. Example: BMPone of
BMPGIFJPGPNGTIFHEIC file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
new_image_formatstringrequired- Select the new image file format. One of: BMP, GIF, JPG, PNG, TIF. Example: BMPone of
BMPGIFJPGPNGTIF
encodian_image_resizeResize an image by percentage or to a width and height.WriteResize Image
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
image_resize_typestringrequired- Set whether the image should be resized to a ratio or specific dimensions. One of: Percentage, Specific. Example: Percentageone of
PercentageSpecific aspect_ratio_dimensionstring- 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: Widthone of
WidthHeightLargest image_heightinteger- For specific resize actions - Set the specific height of the image in pixels. Example: 10
image_resize_resolution_modestring- 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: Metadataone of
MetadataResample image_resolutioninteger- Optional - Specify an image resolution, by default the current image resolution will be used. Example: 10
image_widthinteger- For specific resize actions - Set the specific width of the image in pixels. Example: 12345
maintain_aspect_ratioboolean- 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_percentageinteger- For percentage resize actions - Set the percentage the image should be decrased or increased in size by. Example: 25
encodian_image_text_extractRead the text in an image with AI OCR, with optional clean-up.WriteExtract Text from Image (OCR)
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.
Inputs
auto_rotate_confidence_levelintegerrequired- Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 70. Example: 0
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
image_typestringrequired- Select the image file format. One of: JPG, PNG, TIFF, BMP. Example: JPGone of
JPGPNGTIFFBMP adjust_brightness_contrastboolean- This action analyzes a document and automatically adjusts brightness and contrast based on the analysis. Example: false
apply_average_filterboolean- Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window. Example: false
auto_rotateboolean- Automatically detects orientation and rotates it so that the text on it is upright oriented. Example: false
binarizeboolean- 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_typestring- Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document. One of: Default, None, Specific. Example: Noneone of
DefaultNoneSpecific deskewboolean- Detects the skew angle and rotates to remove that skew. Example: false
despeckleboolean- Automatically detects speckles and removes them. Example: false
image_detergentboolean- 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_languagestring- Select the language used for OCR processing. Example: Englishone of
AlbanianArabicAzerbaijaniBasqueBelarusianBengaliBosnianBulgarianBurmeseCatalanChineseSimplifiedChineseTraditionalCroatianCzechDanishDutchEnglishEstonianFinnishFrenchGeorgianGermanGreekGujaratiHebrewHindiHungarianIcelandicIndonesianItalianJapaneseKannadaKazakhKhmerKoreanKurdishKyrgyzLaotianLatinLatvianLithuanianMacedonianMaharashtraMalayMalayalamMalteseNepaliNorwegianOriyaPanjabiPersianPolishPortuguesePushtoRomanianRussianSanskritSerbianSinghaleseSlovakianSlovenianSpanishSwahiliSwedishSyriacTamilTeluguThaiTurkishUkrainianUrduUzbekVietnameseWelshYiddish remove_borderboolean- Locates border pixels and removes the pixels from the document,this is disabled by default. Example: false
remove_dot_shadingboolean- This action will remove shaded regions from bitonal documents. Example: false
remove_hole_punchboolean- Detects and removes hole punch marks from a bitonal document. Example: false
smooth_backgroundboolean- This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise. Example: false
smooth_objectsboolean- 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
encodian_json_to_excel_convertConvert JSON data into an Excel workbook, optionally into an existing file.WriteConvert JSON to Excel
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.
Inputs
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
columninteger- The first column to be written to. Example: 0
convert_numeric_and_dateboolean- Auto parse numeric and date values, setting the cell format category to 'Number' or 'Date'. Example: false
date_formatstring- 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_contentstring- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
ignore_attribute_titlesboolean- Ignores titles of JSON attributes when converting JSON to Excel. Example: false
ignore_nullsboolean- Ignore JSON properties which contain null values. Example: false
is_title_boldboolean- Set the title to bold. Example: true
is_title_text_wrappedboolean- Set whether a titles text is wrapped. Example: true
json_datastring- Optional - The JSON data to be converted to an Excel document. Example: [{"Name": "Jane", "Total": 120}]
numeric_formatstring- Set the numeric format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings. Example: 0.00
rowinteger- The first row to be written to. Example: 0
title_font_colourstring- Set the title font color. Example: Blackone of
AliceBlueAntiqueWhiteAquaAquamarineAzureBeigeBisqueBlackBlanchedAlmondBlueBlueVioletBrownBurlyWoodCadetBlueChartreuseChocolateCoralCornflowerBlueCornsilkCrimsonCyanDarkBlueDarkCyanDarkGoldenrodDarkGrayDarkGreenDarkKhakiDarkMagentaDarkOliveGreenDarkOrangeDarkOrchidDarkRedDarkSalmonDarkSeaGreenDarkSlateBlueDarkSlateGrayDarkTurquoiseDarkVioletDeepPinkDeepSkyBlueDimGrayDodgerBlueFirebrickFloralWhiteForestGreenFuchsiaGainsboroGhostWhiteGoldGoldenrodGrayGreenGreenYellowHoneydewHotPinkIndianRedIndigoIvoryKhakiLavenderLavenderBlushLawnGreenLemonChiffonLightBlueLightCoralLightCyanLightGoldenrodYellowLightGrayLightGreenLightPinkLightSalmonLightSeaGreenLightSkyBlueLightSlateGrayLightSteelBlueLightYellowLimeLimeGreenLinenMagentaMaroonMediumAquamarineMediumBlueMediumOrchidMediumPurpleMediumSeaGreenMediumSlateBlueMediumSpringGreenMediumTurquoiseMediumVioletRedMidnightBlueMintCreamMistyRoseMoccasinNavajoWhiteNavyOldLaceOliveOliveDrabOrangeOrangeRedOrchidPaleGoldenrodPaleGreenPaleTurquoisePaleVioletRedPapayaWhipPeachPuffPeruPinkPlumPowderBluePurpleRedRosyBrownRoyalBlueSaddleBrownSalmonSandyBrownSeaGreenSeaShellSiennaSilverSkyBlueSlateBlueSlateGraySnowSpringGreenSteelBlueTanTealThistleTomatoTransparentTurquoiseVioletWheatWhiteWhiteSmokeYellowYellowGreen worksheet_namestring- The name of the worksheet that the JSON data is added to. Example: Sheet1
encodian_json_to_xml_convertConvert a JSON string to XML.WriteConvert JSON to XML
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.
Inputs
jsonstringrequired- The JSON to convert to XML. Example: {"order": {"id": 1042}}
include_array_attributeboolean- Set whether to include an array attribute for collections. Example: false
root_namestring- Set the name of the the 'Root' XML element. Example: root
encodian_password_generateGenerate a random password with the chosen length and character sets.WriteGenerate Password
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.
Inputs
lengthintegerrequired- Set the length of the password. Example: 16
exclude_charactersstring- Specify a list of characters to exclude from the password. Example: O0l1
include_lower_caseboolean- Set whether lower case characters should be included within the password. Example: true
include_numbersboolean- Set whether numbers should be included within the password. Example: true
include_symbolsboolean- Set whether symbols should be included within the password. Example: true
include_upper_caseboolean- Set whether upper case characters should be included within the password. Example: true
encodian_pdf_compressReduce a PDF's size by compressing images and removing unused objects.WriteCompress PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
allow_reuse_page_contentboolean- Page contents will be reused when the PDF document is optimized for equal pages. Example: true
compress_imagesboolean- Contained images will be compressed, aligned to the value of the 'Image Quality' property. Example: true
delete_annotationsboolean- Delete all annotations contained within the PDF document. Example: false
flatten_annotationsboolean- Flatten all annotations contained within the PDF document. Example: true
flatten_fieldsboolean- Flatten all fields contained within the PDF document (AcroForms only). Example: true
image_qualityinteger- Sets the quality for compressed images: 1 > 100. Example: 80
link_duplicate_streamsboolean- 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_resolutioninteger- Specifies the maximum resolution of images (dpi), if the image has a higher resolution it will be scaled dynamically. Example: 150
remove_private_infoboolean- Remove private information from the PDF document, i.e. page piece information. Example: false
remove_unused_objectsboolean- Remove all unused objects (i.e. objects which do not have a reference) are removed from PDF document. Example: true
remove_unused_streamsboolean- Remove all unused resources from the PDF document. Example: true
resize_imagesboolean- 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_fontsboolean- 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
encodian_pdf_form_data_extractExtract the field names and values of a fillable PDF form as JSON.WriteExtract PDF Form Data
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
encodian_pdf_form_fillFill a PDF form's fields from a JSON object of field names and values.WriteFill PDF Form
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
form_datastringrequired- The JSON data to populate with the PDF Form with. Example: {"FullName": "Jane Doe"}
encodian_pdf_info_getGet a PDF's metadata: page count, author, title, dates, permissions and file size.WriteExtract PDF Metadata
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
encodian_pdf_ocr_applyRun OCR on a scanned PDF to add a searchable text layer, with optional image clean-up.WriteApply OCR to PDF
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.
Inputs
auto_rotate_confidence_levelintegerrequired- Sets the minimum confidence percentage (0 to 100) used to control whether the rotation is applied, the default value is 60. Example: 0
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
adjust_brightness_contrastboolean- This action analyzes a document and automatically adjusts brightness and contrast based on the analysis. Example: true
apply_average_filterboolean- Performs a 3x3 Average filter smoothing operation on the document, placing the output in the center of the window. Example: false
auto_rotateboolean- Automatically detects orientation and rotates it so that the text on it is upright oriented. Example: true
binarizeboolean- 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_typestring- Perform document clean-up operations, the default option will auto rotate, auto deskew and auto despeckle the document. One of: Default, None, Specific. Example: Noneone of
DefaultNoneSpecific deskewboolean- Detects the skew angle and rotates to remove that skew. Example: true
despeckleboolean- Automatically detects speckles and removes them. Example: true
image_detergentboolean- 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_languagestring- Select the language used for OCR processing. Example: Englishone of
AlbanianArabicAzerbaijaniBasqueBelarusianBengaliBosnianBulgarianBurmeseCatalanChineseSimplifiedChineseTraditionalCroatianCzechDanishDutchEnglishEstonianFinnishFrenchGeorgianGermanGreekGujaratiHebrewHindiHungarianIcelandicIndonesianItalianJapaneseKannadaKazakhKhmerKoreanKurdishKyrgyzLaotianLatinLatvianLithuanianMacedonianMaharashtraMalayMalayalamMalteseNepaliNorwegianOriyaPanjabiPersianPolishPortuguesePushtoRomanianRussianSanskritSerbianSinghaleseSlovakianSlovenianSpanishSwahiliSwedishSyriacTamilTeluguThaiTurkishUkrainianUrduUzbekVietnameseWelshYiddish ocr_typestring- 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: Qualityone of
QualityFast pdfa_complianceboolean- Set PDF/A Compliance option. Example: false
pdfa_compliance_levelstring- Set the PDF/A Compliance Level, the default value is PDF_A_2A. Example: PDF_A_2Aone of
PDF_A_1APDF_A_1BPDF_A_2APDF_A_3APDF_A_2BPDF_A_2UPDF_A_3BPDF_A_3Uv_1_3v_1_4v_1_5v_1_6v_1_7PDF_X_1APDF_X_3 remove_blank_pagesboolean- Set whether blank pages should be removed from the PDF document. Example: false
remove_borderboolean- Locates border pixels and removes the pixels from the document,this is disabled by default. Example: false
remove_dot_shadingboolean- This action will remove shaded regions from bitonal documents. Example: false
remove_hole_punchboolean- Detects and removes hole punch marks from a bitonal document. Example: false
smooth_backgroundboolean- This works only on color and grayscale documents. This operation smoothes background colors to eliminate or de-emphasize noise. Example: false
smooth_objectsboolean- 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
encodian_pdf_page_numbers_addAdd page numbers to a PDF with format, position and font options.WriteAdd Page Numbers to PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
add_to_backgroundboolean- 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_formatstring- Set a custom number format, for example '{0:00000}' would generate 00001. Example: Page [PageNumber] of [TotalPages]
fontstring- Specify the name of the font, if the font cannot be found the default 'Arial' will be used. Example: Arial
font_colourstring- Set the HTML colour of the font, the default colour is set to #000000. Example: #000000
font_sizeinteger- Set the size of the font, the default size is set to 14. Example: 14
horizontal_alignmentstring- 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: Centerone of
NoneLeftCenterRightJustifyFullJustify margin_bottomnumber- Set the bottom margin value (pt). The default value is set to 20. Example: 20
margin_leftnumber- Set the left margin value (pt). The default value is set to 20. Example: 20
margin_rightnumber- Set the right margin value(pt). The default value is set to 20. Example: 20
margin_topnumber- Set the top margin value (pt). The default value is set to 20. Example: 20
opacitynumber- 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_formatstring- 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_numberinteger- Set the starting number for the page number(s) added to the document. Example: 1
start_pageinteger- Set which page to start adding page number(s) from. Example: 1
encodian_pdf_pages_deleteRemove a page range or specific pages from a PDF.WriteDelete PDF Pages
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
end_pageinteger- 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_numbersstring- A comma separated list of page numbers of the pages to delete: 1,3,4. Example: 1,3
start_pageinteger- Set the page number to begin deleting pages from. Example: 1
encodian_pdf_pages_extractExtract a page range or specific pages from a PDF into a new PDF.WriteExtract PDF Pages
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
end_pageinteger- 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_numbersstring- A comma separated list of page numbers of the pages to extract: 1,3,4. Example: 1,3
start_pageinteger- Set the page number to begin extracting pages from. Example: 1
encodian_pdf_redactPermanently redact text that matches the given phrases or patterns from a PDF.WriteRedact PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
redactionsarrayrequired- The collection of redactions to apply to this PDF document. Example: [{"SearchText": "Jane Doe"}]
encodian_pdf_securePassword-protect a PDF and set its printing, copying and editing permissions.WriteSecure PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
admin_passwordstring- Protect edit access to the document. Example: Adm1n!pass
crypto_algorithmstring- Set the cryptographic algorithm. One of: RC4x40, RC4x128, AESx128, AESx256, Custom. Example: AESx256one of
RC4x40RC4x128AESx128AESx256Custom pdf_privilegesstring- Set the privileges assigned to the PDF document. One of: AllowAll, DenyAll, Specific. Example: DenyAllone of
AllowAllDenyAllSpecific pdf_privileges_allow_assemblyboolean- Set whether document assembly is permitted. Example: false
pdf_privileges_allow_copyboolean- Set whether copy is permitted. Example: false
pdf_privileges_allow_fill_inboolean- Set whether 'Fill in forms' is permitted. Example: false
pdf_privileges_allow_modify_annotationsboolean- Set whether annotation modification is permitted. Example: false
pdf_privileges_allow_modify_contentsboolean- Set whether document content modification is permitted. Example: false
pdf_privileges_allow_printboolean- Set whether print is permitted. Example: false
pdf_privileges_allow_screen_readersboolean- Set whether screen reading is permitted. Example: false
user_passwordstring- Protect view access to the document. Example: S3cret!pass
encodian_pdf_splitSplit a PDF into several files by page numbers, page count or bookmarks.WriteSplit PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
split_by_typestringrequired- Select how to split the file. One of: NumberOfPages, PageArray, BookmarkLevel. Example: NumberOfPagesone of
NumberOfPagesPageArrayBookmarkLevel split_configurationstringrequired- Provide a split configuration. Example: 1,3,5
enable_bookmark_filenamesboolean- Append the bookmark name value to the filename when splitting by 'BookmarkLevel'. Example: false
encodian_pdf_tables_extractExtract the tables in a PDF as structured JSON data.WriteExtract Table Data from PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
end_pageinteger- Optional - Specifies the page number to stop extracting pages on. Example: 2
extractstring- Specify the table to extract. One of: First, Last, Custom. Example: Firstone of
FirstLastCustom has_header_rowboolean- Set whether the first row is a header row. Example: true
start_pageinteger- Optional - Specifies the page number to start extracting pages from. Example: 1
table_indexinteger- Optional - If 'Extract' is set to 'Custom', specify the index of the table to extract. Example: 10
encodian_pdf_text_extractExtract the text layer of a PDF, optionally for a page range.WriteExtract Text from PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
end_pageinteger- 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_charactersboolean- Set whether to automatically remove 'Control Characters' from the extracted text. Example: true
start_pageinteger- Sets the page number to begin text layer extraction from. Example: 1
text_encoding_typestring- The encoding type used for text extraction. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: UTF8one of
DefaultLatin1BigEndianUnicodeUTF16UTF8UTF7ASCII
encodian_pdf_text_watermark_addAdd a text watermark (for example CONFIDENTIAL) to every page of a PDF.WriteAdd Text Watermark to PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
textstringrequired- The text to embed as a watermark within the document. Example: CONFIDENTIAL
fontstring- The font applied to the text watermark, the default font is set to Arial. Example: Arial
horizontal_alignmentstring- Set the horizontal alignment of the watermark, the default value is Center. One of: Left, Center, Right, FullJustify, Justify, None. Example: Centerone of
LeftCenterRightFullJustifyJustifyNone opacitynumber- The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.0. Example: 1
orientationstring- The orientation of the text to embed as a watermark within the document. One of: Vertical, Horizontal, Diagonal. Example: Horizontalone of
VerticalHorizontalDiagonal paddingstring- A comma delimited padding configuration 5,0,5,0 in the order top, right, bottom, left. Example: 5,0,5,0
skip_first_pageboolean- Set whether to skip applying the watermark to the first page. Example: false
text_colourstring- The HTML colour applied to the text watermark, the default colour is set to #E81123. Example: #FF0000
text_sizeinteger- The size of the font applied to the text watermark, the default size is set to 34. Example: 34
vertical_alignmentstring- Set the vertical alignment of the watermark, the default value is Center. One of: Top, Center, Bottom, None. Example: Centerone of
TopCenterBottomNone
encodian_pdf_to_excel_convertConvert the tables in a PDF document into an Excel workbook.WriteConvert PDF to Excel
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
encodian_pdf_to_images_convertConvert each page of a PDF into an image file.WriteConvert PDF to Images
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
image_formatstringrequired- Set the format for the output image files. One of: JPG, PNG. Example: PNGone of
JPGPNG filename_prefixstring- The prefix filename for the output image files. Example: page
resolutioninteger- Set the image resolution. Example: 300
encodian_pdf_to_word_convertConvert a PDF document to an editable Word document.WriteConvert PDF to Word
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
modestring- Mode. One of: Full, PreserveLayout. Example: Fullone of
FullPreserveLayout recognize_bulletsboolean- Recognize Bullets. Example: true
encodian_pdf_unlockRemove password protection from a PDF using its password.WriteUnlock PDF
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
passwordstringrequired- The password to use to unlock the PDF Document. Example: S3cret!pass
encodian_qr_code_createCreate a QR code image from text or a URL, with size, colour and logo options.WriteCreate QR Code
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.
Inputs
barcode_datastringrequired- Set the string value used to generate the QR barcode. Example: https://acme.com
barcode_image_formatstringrequired- Set the image format for barcode. One of: PNG, JPG, SVG, BMP, TIFF, GIF. Example: PNGone of
PNGJPGSVGBMPTIFFGIF back_colorstring- Set the QR code background color (HTML Color #FFFFFF) Example: White
border_colorstring- Set the QR code border color (HTML Color #000000) Example: Black
border_stylestring- Set the QR code border style. One of: Dash, DashDot, DashDotDot, Dot, Solid. Example: Solidone of
DashDashDotDashDotDotDotSolid border_widthinteger- Set the QR code border width in pixels. Example: 2
caption_above_alignmentstring- Set the alignment of the caption text. One of: Left, Centre, Right. Example: Leftone of
LeftCentreRight caption_above_fontstring- Set the font for the caption text. Example: example
caption_above_font_colourstring- Set the font colour for the caption text. Example: Blackone of
AliceBlueAntiqueWhiteAquaAquamarineAzureBeigeBisqueBlackBlanchedAlmondBlueBlueVioletBrownBurlyWoodCadetBlueChartreuseChocolateCoralCornflowerBlueCornsilkCrimsonCyanDarkBlueDarkCyanDarkGoldenrodDarkGrayDarkGreenDarkKhakiDarkMagentaDarkOliveGreenDarkOrangeDarkOrchidDarkRedDarkSalmonDarkSeaGreenDarkSlateBlueDarkSlateGrayDarkTurquoiseDarkVioletDeepPinkDeepSkyBlueDimGrayDodgerBlueFirebrickFloralWhiteForestGreenFuchsiaGainsboroGhostWhiteGoldGoldenrodGrayGreenGreenYellowHoneydewHotPinkIndianRedIndigoIvoryKhakiLavenderLavenderBlushLawnGreenLemonChiffonLightBlueLightCoralLightCyanLightGoldenrodYellowLightGrayLightGreenLightPinkLightSalmonLightSeaGreenLightSkyBlueLightSlateGrayLightSteelBlueLightYellowLimeLimeGreenLinenMagentaMaroonMediumAquamarineMediumBlueMediumOrchidMediumPurpleMediumSeaGreenMediumSlateBlueMediumSpringGreenMediumTurquoiseMediumVioletRedMidnightBlueMintCreamMistyRoseMoccasinNavajoWhiteNavyOldLaceOliveOliveDrabOrangeOrangeRedOrchidPaleGoldenrodPaleGreenPaleTurquoisePaleVioletRedPapayaWhipPeachPuffPeruPinkPlumPowderBluePurpleRedRosyBrownRoyalBlueSaddleBrownSalmonSandyBrownSeaGreenSeaShellSiennaSilverSkyBlueSlateBlueSlateGraySnowSpringGreenSteelBlueTanTealThistleTomatoTransparentTurquoiseVioletWheatWhiteWhiteSmokeYellowYellowGreen caption_above_font_sizeinteger- Set the size of font for the caption text. Example: 25
caption_above_no_wrapboolean- Set the wrapping of the caption text. Example: true
caption_above_textstring- Set the caption above text. Example: example
caption_below_alignmentstring- Set the alignment of the caption text. One of: Left, Centre, Right. Example: Leftone of
LeftCentreRight caption_below_fontstring- Set the font for the caption text. Example: example
caption_below_font_colourstring- Set the font colour for the caption text. Example: AliceBlueone of
AliceBlueAntiqueWhiteAquaAquamarineAzureBeigeBisqueBlackBlanchedAlmondBlueBlueVioletBrownBurlyWoodCadetBlueChartreuseChocolateCoralCornflowerBlueCornsilkCrimsonCyanDarkBlueDarkCyanDarkGoldenrodDarkGrayDarkGreenDarkKhakiDarkMagentaDarkOliveGreenDarkOrangeDarkOrchidDarkRedDarkSalmonDarkSeaGreenDarkSlateBlueDarkSlateGrayDarkTurquoiseDarkVioletDeepPinkDeepSkyBlueDimGrayDodgerBlueFirebrickFloralWhiteForestGreenFuchsiaGainsboroGhostWhiteGoldGoldenrodGrayGreenGreenYellowHoneydewHotPinkIndianRedIndigoIvoryKhakiLavenderLavenderBlushLawnGreenLemonChiffonLightBlueLightCoralLightCyanLightGoldenrodYellowLightGrayLightGreenLightPinkLightSalmonLightSeaGreenLightSkyBlueLightSlateGrayLightSteelBlueLightYellowLimeLimeGreenLinenMagentaMaroonMediumAquamarineMediumBlueMediumOrchidMediumPurpleMediumSeaGreenMediumSlateBlueMediumSpringGreenMediumTurquoiseMediumVioletRedMidnightBlueMintCreamMistyRoseMoccasinNavajoWhiteNavyOldLaceOliveOliveDrabOrangeOrangeRedOrchidPaleGoldenrodPaleGreenPaleTurquoisePaleVioletRedPapayaWhipPeachPuffPeruPinkPlumPowderBluePurpleRedRosyBrownRoyalBlueSaddleBrownSalmonSandyBrownSeaGreenSeaShellSiennaSilverSkyBlueSlateBlueSlateGraySnowSpringGreenSteelBlueTanTealThistleTomatoTransparentTurquoiseVioletWheatWhiteWhiteSmokeYellowYellowGreen caption_below_font_sizeinteger- Set the size of font for the caption text. Example: 25
caption_below_no_wrapboolean- Set the wrapping of the caption text. Example: true
caption_below_textstring- Set the caption below text. Example: example
encode_modestring- Set the QR code encode mode. One of: Auto, Bytes, ECIEncoding, ExtendedCodetext, Utf16BEBOM, Utf8BOM. Example: Autoone of
AutoBytesECIEncodingExtendedCodetextUtf16BEBOMUtf8BOM encode_typestring- Set the QR code encode type. One of: Auto, ForceMicroQR, ForceQR. Example: ForceQRone of
AutoForceMicroQRForceQR fore_colorstring- Set the QR code foreground color (HTML Color #000000) Example: Black
heightinteger- Set the QR code height (pixels). Example: 88
logo_file_contentstring- The file content of the source logo file. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
logo_file_namestring- The filename of the source logo file, the file extension is mandatory: 'file.png' and not 'file'. Example: logo.png
logo_positionstring- Set the position of the logo. One of: Top, Centre. Example: Topone of
TopCentre resolutioninteger- Set the QR code border image resolution (dpi) Example: 96
size_modestring- Set the QR auto size mode, use 'Nearest' to assure QR code readability. One of: None, Nearest, Fixed, Interpolation. Example: Nearestone of
NoneNearestFixedInterpolation text_encoding_typestring- Set the QR code text encoding type. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: Defaultone of
DefaultLatin1BigEndianUnicodeUTF16UTF8UTF7ASCII visible_borderboolean- Set whether the QR code border is visible. Example: true
widthinteger- Set the QR code width (pixels). Example: 88
encodian_qr_codes_readRead the QR codes in a PDF or Word document.WriteRead QR Codes from Document
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
barcode_read_confidencestring- Set the confidence level for barcode detection. One of: Low, Medium, High. Example: Mediumone of
LowMediumHigh barcode_read_qualitystring- Controls barcode detection quality. Higher settings may improve recognition but reduce performance. One of: Normal, High, Low, Max. Example: Normalone of
NormalHighLowMax barcode_remove_control_charsboolean- Set whether recognised control characters should be removed. Example: true
end_pageinteger- Set the page number to end reading on. Example: 2
file_typestring- Select the source document format. One of: PDF, DOCX. Example: PDFone of
PDFDOCX start_pageinteger- Set the page number to begin reading from. Example: 1
encodian_text_email_addresses_extractFind every email address in a text.WriteExtract Email Addresses from Text
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.
Inputs
regexstringrequired- The default regular expression used for extraction. Example: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}
textstringrequired- The text from which email addresses are to be extracted. Example: Contact sales@acme.com or visit https://acme.com for details.
encodian_text_regex_searchSearch a text with a regular expression and return the matches (and groups).WriteSearch Text with Regex
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.
Inputs
querystringrequired- The regex query to use to find matches in the string provided. Example: \d{4}
textstringrequired- The text to search with the regex string provided. Example: Contact sales@acme.com or visit https://acme.com for details.
ecma_scriptboolean- 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_captureboolean- Specifies that the only valid captures are explicitly named or numbered groups of the form, disabled by default. Example: false
ignore_caseboolean- Specifies case-insensitive matching, disabled by default. Example: false
ignore_whitespaceboolean- Eliminates unescaped white space from the pattern and enables comments marked with #, disabled by default. Example: false
multilineboolean- 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_groupsboolean- Specifies that the search will return match groups rather than match values. Example: false
right_to_leftboolean- Specifies that the search will be from right to left instead of from left to right, disabled by default. Example: false
singlelineboolean- 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
encodian_text_to_pdf_convertConvert plain text (inline or a text file) to a PDF document.WriteConvert Text to PDF
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.
Inputs
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
output_filenamestringrequired- File name for the output file, including its extension. Example: output.pdf
file_contentstring- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
text_datastring- 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_typestring- The encoding type used for text conversion. One of: Default, Latin1, BigEndianUnicode, UTF16, UTF8, UTF7, ASCII. Example: Defaultone of
DefaultLatin1BigEndianUnicodeUTF16UTF8UTF7ASCII
encodian_text_urls_extractFind every URL in a text.WriteExtract URLs from Text
Find every URL in a text. Returns result, httpStatusCode, httpStatusMessage, operationId, errors, operationStatus. Returns an array of URLs. Each call uses Encodian Flowr credits.
Inputs
regexstringrequired- The default regular expression used for extraction. Example: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}
textstringrequired- The text from which URL's are to be extracted. Example: Contact sales@acme.com or visit https://acme.com for details.
encodian_time_zone_convertConvert a date and time from one time zone to another (Windows time zone names).WriteConvert Time Zone
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.
Inputs
datestringrequired- The date and time value to convert. Example: 2026-03-01T09:00:00Z
new_time_zonestringrequired- Set the new time zone. Example: GMTStandardTimeone of
DefaultAUSCentralStandardTimeAUSEasternStandardTimeAfghanistanStandardTimeAlaskanStandardTimeAleutianStandardTimeAltaiStandardTimeArabStandardTimeArabianStandardTimeArabicStandardTimeArgentinaStandardTimeAstrakhanStandardTimeAtlanticStandardTimeAusCentralWStandardTimeAzerbaijanStandardTimeAzoresStandardTimeBahiaStandardTimeBangladeshStandardTimeBelarusStandardTimeBougainvilleStandardTimeCanadaCentralStandardTimeCapeVerdeStandardTimeCaucasusStandardTimeCenAustraliaStandardTimeCentralAmericaStandardTimeCentralAsiaStandardTimeCentralBrazilianStandardTimeCentralEuropeStandardTimeCentralEuropeanStandardTimeCentralPacificStandardTimeCentralStandardTimeCentralStandardTimeMexicoChathamIslandsStandardTimeChinaStandardTimeCubaStandardTimeDatelineStandardTimeEAfricaStandardTimeEAustraliaStandardTimeEEuropeStandardTimeESouthAmericaStandardTimeEasterIslandStandardTimeEasternStandardTimeEasternStandardTimeMexicoEgyptStandardTimeEkaterinburgStandardTimeFLEStandardTimeFijiStandardTimeGMTStandardTimeGTBStandardTimeGeorgianStandardTimeGreenlandStandardTimeGreenwichStandardTimeHaitiStandardTimeHawaiianStandardTimeIndiaStandardTimeIranStandardTimeIsraelStandardTimeJordanStandardTimeKaliningradStandardTimeKamchatkaStandardTimeKoreaStandardTimeLibyaStandardTimeLineIslandsStandardTimeLordHoweStandardTimeMagadanStandardTimeMagallanesStandardTimeMarquesasStandardTimeMauritiusStandardTimeMidAtlanticStandardTimeMiddleEastStandardTimeMontevideoStandardTimeMoroccoStandardTimeMountainStandardTimeMountainStandardTimeMexicoMyanmarStandardTimeNCentralAsiaStandardTimeNamibiaStandardTimeNepalStandardTimeNewZealandStandardTimeNewfoundlandStandardTimeNorfolkStandardTimeNorthAsiaEastStandardTimeNorthAsiaStandardTimeNorthKoreaStandardTimeOmskStandardTimePacificSAStandardTimePacificStandardTimePacificStandardTimeMexicoPakistanStandardTimeParaguayStandardTimeQyzylordaStandardTimeRomanceStandardTimeRussiaTimeZone10RussiaTimeZone11RussiaTimeZone3RussianStandardTimeSAEasternStandardTimeSAPacificStandardTimeSAWesternStandardTimeSEAsiaStandardTimeSaintPierreStandardTimeSakhalinStandardTimeSamoaStandardTimeSaoTomeStandardTimeSaratovStandardTimeSingaporeStandardTimeSouthAfricaStandardTimeSouthSudanStandardTimeSriLankaStandardTimeSudanStandardTimeSyriaStandardTimeTaipeiStandardTimeTasmaniaStandardTimeTocantinsStandardTimeTokyoStandardTimeTomskStandardTimeTongaStandardTimeTransbaikalStandardTimeTurkeyStandardTimeTurksAndCaicosStandardTimeUSEasternStandardTimeUSMountainStandardTimeUTCUTC02UTC08UTC09UTC11UTC12UTC13UlaanbaatarStandardTimeVenezuelaStandardTimeVladivostokStandardTimeVolgogradStandardTimeWAustraliaStandardTimeWCentralAfricaStandardTimeWEuropeStandardTimeWMongoliaStandardTimeWestAsiaStandardTimeWestBankStandardTimeWestPacificStandardTimeYakutskStandardTimeYukonStandardTime current_time_zonestring- Set the current time zone. Example: EasternStandardTimeone of
DefaultAUSCentralStandardTimeAUSEasternStandardTimeAfghanistanStandardTimeAlaskanStandardTimeAleutianStandardTimeAltaiStandardTimeArabStandardTimeArabianStandardTimeArabicStandardTimeArgentinaStandardTimeAstrakhanStandardTimeAtlanticStandardTimeAusCentralWStandardTimeAzerbaijanStandardTimeAzoresStandardTimeBahiaStandardTimeBangladeshStandardTimeBelarusStandardTimeBougainvilleStandardTimeCanadaCentralStandardTimeCapeVerdeStandardTimeCaucasusStandardTimeCenAustraliaStandardTimeCentralAmericaStandardTimeCentralAsiaStandardTimeCentralBrazilianStandardTimeCentralEuropeStandardTimeCentralEuropeanStandardTimeCentralPacificStandardTimeCentralStandardTimeCentralStandardTimeMexicoChathamIslandsStandardTimeChinaStandardTimeCubaStandardTimeDatelineStandardTimeEAfricaStandardTimeEAustraliaStandardTimeEEuropeStandardTimeESouthAmericaStandardTimeEasterIslandStandardTimeEasternStandardTimeEasternStandardTimeMexicoEgyptStandardTimeEkaterinburgStandardTimeFLEStandardTimeFijiStandardTimeGMTStandardTimeGTBStandardTimeGeorgianStandardTimeGreenlandStandardTimeGreenwichStandardTimeHaitiStandardTimeHawaiianStandardTimeIndiaStandardTimeIranStandardTimeIsraelStandardTimeJordanStandardTimeKaliningradStandardTimeKamchatkaStandardTimeKoreaStandardTimeLibyaStandardTimeLineIslandsStandardTimeLordHoweStandardTimeMagadanStandardTimeMagallanesStandardTimeMarquesasStandardTimeMauritiusStandardTimeMidAtlanticStandardTimeMiddleEastStandardTimeMontevideoStandardTimeMoroccoStandardTimeMountainStandardTimeMountainStandardTimeMexicoMyanmarStandardTimeNCentralAsiaStandardTimeNamibiaStandardTimeNepalStandardTimeNewZealandStandardTimeNewfoundlandStandardTimeNorfolkStandardTimeNorthAsiaEastStandardTimeNorthAsiaStandardTimeNorthKoreaStandardTimeOmskStandardTimePacificSAStandardTimePacificStandardTimePacificStandardTimeMexicoPakistanStandardTimeParaguayStandardTimeQyzylordaStandardTimeRomanceStandardTimeRussiaTimeZone10RussiaTimeZone11RussiaTimeZone3RussianStandardTimeSAEasternStandardTimeSAPacificStandardTimeSAWesternStandardTimeSEAsiaStandardTimeSaintPierreStandardTimeSakhalinStandardTimeSamoaStandardTimeSaoTomeStandardTimeSaratovStandardTimeSingaporeStandardTimeSouthAfricaStandardTimeSouthSudanStandardTimeSriLankaStandardTimeSudanStandardTimeSyriaStandardTimeTaipeiStandardTimeTasmaniaStandardTimeTocantinsStandardTimeTokyoStandardTimeTomskStandardTimeTongaStandardTimeTransbaikalStandardTimeTurkeyStandardTimeTurksAndCaicosStandardTimeUSEasternStandardTimeUSMountainStandardTimeUTCUTC02UTC08UTC09UTC11UTC12UTC13UlaanbaatarStandardTimeVenezuelaStandardTimeVladivostokStandardTimeVolgogradStandardTimeWAustraliaStandardTimeWCentralAfricaStandardTimeWEuropeStandardTimeWMongoliaStandardTimeWestAsiaStandardTimeWestBankStandardTimeWestPacificStandardTimeYakutskStandardTimeYukonStandardTime
encodian_word_documents_compareCompare two Word documents and return a document with the differences as tracked changes.WriteCompare Word Documents
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.
Inputs
file_content_onestringrequired- The first Word document's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_content_twostringrequired- The second Word document's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
authorstring- Set the name of the author used to denote differences in the output document. Example: Jane Doe
case_insensitiveboolean- Specifies whether to compare differences in documents as case insensitive. Example: false
ignore_commentsboolean- Specifies whether to compare differences in comments. Example: false
ignore_fieldsboolean- Specifies whether to compare differences in fields. By default fields. Example: false
ignore_footnotesboolean- Specifies whether to compare differences in footnotes and endnotes. Example: false
ignore_formattingboolean- Specifies whether to ignore document formatting differences. Example: false
ignore_headers_and_footersboolean- Specifies whether to compare differences in the data contained within headers and footers. Example: false
ignore_tablesboolean- Specifies whether to compare the differences in data contained in tables. Example: false
ignore_textboxesboolean- Specifies whether to compare differences in the data contained within text boxes. Example: false
encodian_word_secureProtect a Word document with a password and an editing restriction.WriteSecure Word Document
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
passwordstring- Set the password used to protect the Microsoft Word document. Example: S3cret!pass
secure_on_openboolean- Set whether a password should be required to open the Microsoft Word document. Example: false
secure_on_open_passwordstring- Set the password used to open the Microsoft Word document. Example: S3cret!pass
word_protection_typestring- Set the protection type for the Microsoft Word document. One of: AllowComments, AllowFormFields, AllowRevisions, ReadOnly, NoProtection. Example: NoProtectionone of
AllowCommentsAllowFormFieldsAllowRevisionsReadOnlyNoProtection
encodian_word_template_populateFill a Word template's merge fields and repeating sections from JSON data.WritePopulate Word Template
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.
Inputs
document_datastringrequired- The JSON data to populate the Microsoft Word Document with. Example: {"customer": {"name": "Jane Doe"}}
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
population_optionsstringrequired- Sets the behaviour of the population engine. One of: Default, AllowMissingMembers, ClearEmptyParagraphs, InlineErrors. Example: Defaultone of
DefaultAllowMissingMembersClearEmptyParagraphsInlineErrors allow_missing_membersboolean- Sets the engine to allow missing values within the 'Document Data'. Example: false
date_time_formatstring- Set one or more specfic formats for parsing DateTime values. Example: yyyy-MM-dd
inline_error_messagesboolean- Produces errors within the resultant document as opposed to rejecting the request with a HTTP 4 error. Example: false
json_parse_modestring- Sets the JSON parsing mode for simple values (null, boolean, number, integer, and string) One of: Standard, Strict. Example: Standardone of
StandardStrict remove_empty_paragraphsboolean- Sets the engine to automatically removes any empty paragraphs upon execution. Example: false
timezonestring- Set a specific time zone for date and time processing. Example: UTCone of
DefaultAUSCentralStandardTimeAUSEasternStandardTimeAfghanistanStandardTimeAlaskanStandardTimeAleutianStandardTimeAltaiStandardTimeArabStandardTimeArabianStandardTimeArabicStandardTimeArgentinaStandardTimeAstrakhanStandardTimeAtlanticStandardTimeAusCentralWStandardTimeAzerbaijanStandardTimeAzoresStandardTimeBahiaStandardTimeBangladeshStandardTimeBelarusStandardTimeBougainvilleStandardTimeCanadaCentralStandardTimeCapeVerdeStandardTimeCaucasusStandardTimeCenAustraliaStandardTimeCentralAmericaStandardTimeCentralAsiaStandardTimeCentralBrazilianStandardTimeCentralEuropeStandardTimeCentralEuropeanStandardTimeCentralPacificStandardTimeCentralStandardTimeCentralStandardTimeMexicoChathamIslandsStandardTimeChinaStandardTimeCubaStandardTimeDatelineStandardTimeEAfricaStandardTimeEAustraliaStandardTimeEEuropeStandardTimeESouthAmericaStandardTimeEasterIslandStandardTimeEasternStandardTimeEasternStandardTimeMexicoEgyptStandardTimeEkaterinburgStandardTimeFLEStandardTimeFijiStandardTimeGMTStandardTimeGTBStandardTimeGeorgianStandardTimeGreenlandStandardTimeGreenwichStandardTimeHaitiStandardTimeHawaiianStandardTimeIndiaStandardTimeIranStandardTimeIsraelStandardTimeJordanStandardTimeKaliningradStandardTimeKamchatkaStandardTimeKoreaStandardTimeLibyaStandardTimeLineIslandsStandardTimeLordHoweStandardTimeMagadanStandardTimeMagallanesStandardTimeMarquesasStandardTimeMauritiusStandardTimeMidAtlanticStandardTimeMiddleEastStandardTimeMontevideoStandardTimeMoroccoStandardTimeMountainStandardTimeMountainStandardTimeMexicoMyanmarStandardTimeNCentralAsiaStandardTimeNamibiaStandardTimeNepalStandardTimeNewZealandStandardTimeNewfoundlandStandardTimeNorfolkStandardTimeNorthAsiaEastStandardTimeNorthAsiaStandardTimeNorthKoreaStandardTimeOmskStandardTimePacificSAStandardTimePacificStandardTimePacificStandardTimeMexicoPakistanStandardTimeParaguayStandardTimeQyzylordaStandardTimeRomanceStandardTimeRussiaTimeZone10RussiaTimeZone11RussiaTimeZone3RussianStandardTimeSAEasternStandardTimeSAPacificStandardTimeSAWesternStandardTimeSEAsiaStandardTimeSaintPierreStandardTimeSakhalinStandardTimeSamoaStandardTimeSaoTomeStandardTimeSaratovStandardTimeSingaporeStandardTimeSouthAfricaStandardTimeSouthSudanStandardTimeSriLankaStandardTimeSudanStandardTimeSyriaStandardTimeTaipeiStandardTimeTasmaniaStandardTimeTocantinsStandardTimeTokyoStandardTimeTomskStandardTimeTongaStandardTimeTransbaikalStandardTimeTurkeyStandardTimeTurksAndCaicosStandardTimeUSEasternStandardTimeUSMountainStandardTimeUTCUTC02UTC08UTC09UTC11UTC12UTC13UlaanbaatarStandardTimeVenezuelaStandardTimeVladivostokStandardTimeVolgogradStandardTimeWAustraliaStandardTimeWCentralAfricaStandardTimeWEuropeStandardTimeWMongoliaStandardTimeWestAsiaStandardTimeWestBankStandardTimeWestPacificStandardTimeYakutskStandardTimeYukonStandardTime
encodian_word_text_extractExtract the text of a Word document, optionally for a page range.WriteExtract Text from Word
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
accept_changesboolean- Set whether tracked changes should be accepted prior to extracting text from the the Microsoft Word file. Example: true
end_pageinteger- 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_commentsboolean- Set whether comments should be removed prior to extracting text from the the Microsoft Word file. Example: true
remove_headers_and_footersboolean- Set whether headers and footers should be removed from the the Microsoft Word file. Example: true
start_pageinteger- Sets the page number to begin text layer extraction from. Example: 1
encodian_word_text_replaceFind and replace phrases in a Word document.WriteReplace Text in Word
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.
Inputs
file_contentstringrequired- The source file's content, base64-encoded. Example: JVBERi0xLjcKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoK
file_namestringrequired- Source file name including its extension (the extension tells Encodian the file type). Example: report.pdf
phrasesarrayrequired- The collection of text phrases to search for and replace. Example: [{"searchText": "{{name}}", "replacementText": "Jane Doe"}]
encodian_xml_to_json_convertConvert an XML string to JSON.WriteConvert XML to JSON
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.
Inputs
xmlstringrequired- The XML to convert to JSON. Example: <order><id>1042</id></order>
omit_root_objectboolean- Set whether the root object should be omitted. Example: false
No tools match.