Aryn

Learn how to use Aryn with Composio

Overview

SLUG: ARYN

Description

Aryn is an AI-powered platform for document parsing, data extraction, and analytics, enabling users to process and query unstructured documents at scale.

Authentication Details

generic_api_key
stringRequired

Connecting to Aryn

Create an auth config

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

1

Select App

Navigate to the Aryn toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

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

3

Create and Get auth config ID

Click “Create Integration”. 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

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

Tools

Executing tools

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

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["ARYN"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def 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
33invoke_llm()

Tool List

Tool Name: Create DocSet

Description

Tool to create a new docset. use when you need to allocate a storage container before adding documents.

Action Parameters

name
stringRequired
prompts
object
properties
object
schema
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create DocSet

Description

Tool to create a new docset. use when you need to allocate a storage container before adding documents.

Action Parameters

name
stringRequired
prompts
object
properties
object
schema
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete DocSet

Description

Tool to delete a docset and all its documents. use after confirming the docset id, when you need to permanently remove a docset and its contents.

Action Parameters

docset_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Generate plan

Description

Tool to generate a query plan without executing it. use when you need to review the logical plan before running your query (e.g., "generate a plan for revenue breakdown by region").

Action Parameters

docset_id
stringRequired
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Document by ID

Description

Tool to retrieve a document by id. use after both docset and document ids are available.

Action Parameters

doc_id
stringRequired
docset_id
stringRequired
include_binary
boolean
include_elements
booleanDefaults to True

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Document Binary

Description

Tool to retrieve the binary content of a document by docset id and document id.

Action Parameters

docsetId
stringRequired
documentId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get DocSet Metadata

Description

Tool to retrieve metadata for a specific docset. use when you have the docset id and optionally need usage statistics.

Action Parameters

docsetId
stringRequired
fields
string
includeStats
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Async Tasks

Description

Tool to list all outstanding asynchronous tasks for the account. use when you need to check pending or running tasks.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired