Encodian | Composio Docs

Overview

SLUG: ENCODIAN

Description

Encodian provides a suite of document management and automation tools, including Flowr, Filer, and Indxr, designed to enhance productivity and streamline workflows within Microsoft 365 environments.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Encodian

Create an auth config

Use the dashboard to create an auth config for the Encodian toolkit. This allows you to connect multiple Encodian accounts to Composio for agents to use.

Select App

Navigate to Encodian.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Encodian Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 encodian_auth_config_id = "ac_YOUR_ENCODIAN_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Encodian for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, encodian_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Encodian toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["ENCODIAN"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

ENCODIAN_BASE64_DECODE

Tool Name: Decode Base64 String

Description

Tool to decode a Base64 string to a file. Use when you need to extract binary content (e.g., PDF, image) from Base64 data.

Action Parameters

Base64String

stringRequired

FileName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_BASE64_ENCODE

Tool Name: Base64 Encode

Description

Tool to encode a string to Base64. Use when you need to convert text into Base64 representation for use in other operations.

Action Parameters

value

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_COMPARE_TEXT

Tool Name: Compare Text

Description

Tool to compare two text strings and determine if they match. Use when you have two strings and need to verify if they are equal.

Action Parameters

ignoreCase

boolean

primaryText

stringRequired

secondaryText

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_GENERAL_HASH

Tool Name: Hash Data

Description

Tool to compute a cryptographic hash (MD5, SHA256, etc.) of text or file data. Use when you need to verify integrity or generate digests.

Action Parameters

Case

string

Data

stringRequired

DataType

stringRequired

DigestAlgorithm

stringRequired

EncodingType

string

OutputType

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_GENERAL_UNZIP_FILE

Tool Name: Unzip File

Description

Tool to extract files from an archive. Use when you need to unzip a package and retrieve its contents.

Action Parameters

file

object

file_content_base64

string

local_path

string

password

string

recursive

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_GET_FILE_PROPERTIES

Tool Name: Get File Properties

Description

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

Action Parameters

BlobName

stringRequired

ContainerName

stringRequired

IncludeMetadata

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_IMAGE_RESIZE

Tool Name: Resize Image

Description

Tool to resize an image by percentage or dimensions. Use when you need to scale or reshape an image with optional aspect-ratio enforcement.

Action Parameters

FileContent

object

FileContentBase64

string

FileName

stringRequired

FilePath

string

ImageHeight

integer

ImageResizeType

stringRequired

ImageResolution

integer

ImageWidth

integer

MaintainAspectRatio

boolean

ResizePercentage

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_MOVE_FILE

Tool Name: Move File

Description

Tool to move a file between containers. Use when you need to relocate a blob within your storage without manually copying then deleting.

Action Parameters

DestinationBlob

stringRequired

DestinationContainer

stringRequired

Overwrite

boolean

SourceBlob

stringRequired

SourceContainer

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_PDF_ADD_HEADER_FOOTER

Tool Name: Add PDF Header Footer

Description

Tool to add HTML header and footer to a PDF. Use when you need to embed consistent headers or footers across pages with margin and range options.

Action Parameters

ApplyTo

string

FileContent

object

FileContentBase64

string

FileName

stringRequired

FilePath

string

FinalOperation

boolean

HtmlHeaderFooter

stringRequired

HtmlHeaderFooterLocation

stringRequired

IgnorePageNumbers

array

MarginBottom

number

MarginLeft

number

MarginRight

number

MarginTop

number

OperationId

string

PageNumbers

array

ReturnFile

boolean

SkipFirstPage

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_PDF_GET_METADATA

Tool Name: Get PDF Metadata

Description

Tool to extract PDF metadata and properties. Use when you need to retrieve details like page count, author, file size, and custom attributes.

Action Parameters

Filename

string

file

object

filePath

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_PDF_WATERMARK

Tool Name: Watermark PDF

Description

Tool to apply a text watermark to a PDF. Use when you need to annotate PDF pages with custom labels or marks; supports page selection, positioning, opacity, and rotation.

Action Parameters

ApplyAsImage

boolean

ApplyTo

string

AutoScale

boolean

AutoScaleTextHeight

integer

AutoScaleTextWidth

integer

EncodingType

string

FileContent

object

FileContentBase64

string

FilePath

string

Filename

stringRequired

Font

string

HorizontalAlignment

string

IgnorePageNumbers

array

Opacity

number

OperationId

string

PageNumbers

array

ReturnFile

boolean

RotationAngle

number

SkipFirstPage

boolean

Text

stringRequired

TextAlignment

string

TextColour

string

TextLayer

boolean

TextSize

integer

TextWrap

boolean

TextWrapRowWidth

integer

VerticalAlignment

string

WatermarkId

string

XIndent

integer

YIndent

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_VALIDATE_EMAIL_ADDRESS

Tool Name: Validate Email Address

Description

Tool to validate an email address. Use when checking email formats against a custom regex before processing user inputs.

Action Parameters

emailAddress

stringRequired

regex

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_VALIDATE_URL_AVAILABILITY

Tool Name: Validate URL Availability

Description

Tool to validate the availability of a specified URL. Use when needing to confirm if a web address is reachable before processing.

Action Parameters

url

stringRequired

validateURL

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

ENCODIAN_WRITE_RANGE

Tool Name: Write Range to Excel

Description

Tool to write values to a cell range in an Excel worksheet. Use when you need to programmatically update worksheet data by specifying a range and a 2D array of values.

Action Parameters

file

object

filePath

string

outputFilename

string

range

stringRequired

values

arrayRequired

worksheetName

string

Action Response

data

objectRequired

error

string

successful

booleanRequired