Agenty

Learn how to use Agenty with Composio

Overview

SLUG: AGENTY

Description

Agenty is a web scraping and automation platform that enables users to extract data, monitor changes, and automate browser tasks without coding.

Authentication Details

generic_api_key
stringRequired

Connecting to Agenty

Create an auth config

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

1

Select App

Navigate to the Agenty 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
5agenty_auth_config_id = "ac_YOUR_AGENTY_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 Agenty 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, agenty_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 Agenty 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=["AGENTY"])
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: Clone Agent by ID

Description

Tool to clone an existing agent by its id. use when you need to duplicate an agent's configuration and optionally start the clone immediately.

Action Parameters

agent_id
stringRequired
start
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Agent

Description

Tool to create a new agent. use when you need to add an agent with configuration and optional auto-start.

Action Parameters

account_id
integer
agent_id
string
config
objectRequired
created_at
string
description
string
icon
string
is_managed
boolean
is_public
boolean
name
stringRequired
project_id
integer
scheduler
object
scripts
object
start
boolean
tags
array
type
stringRequired
updated_at
string
user_id
integer
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Agent Templates

Description

Tool to fetch all public agent templates and sample agents. use when listing available templates for users to select.

Action Parameters

limit
integerDefaults to 1000
offset
integer
order
string
sort
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Delete Agent by ID

Description

Tool to delete a single agent by its id. use when you need to permanently remove an agent after confirming it exists.

Action Parameters

agent_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch all agents

Description

Tool to fetch all active agents under an account. use after authenticating when you need to list agents with pagination and sorting.

Action Parameters

limit
integer
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Agent by ID

Description

Tool to fetch details of a specific agent by its id. use when you need full agent configuration before taking further actions.

Action Parameters

agent_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Agent by ID

Description

Tool to update an agent's configuration and settings by agent id. use when you need to modify an existing agent after retrieving its current settings. example: "update agent 123 with new name and tags."

Action Parameters

account_id
integer
agent_id
stringRequired
config
objectRequired
created_at
string
description
string
icon
string
is_managed
boolean
is_public
boolean
name
stringRequired
project_id
integer
scheduler
object
scripts
object
tags
array
type
stringRequired
updated_at
string
user_id
integer
version
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create API Key

Description

Tool to create a new api key. use when you need to provision access credentials for the api.

Action Parameters

is_enabled
booleanDefaults to True
name
stringRequired
role
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete API key by ID

Description

Tool to delete an api key by its key id. use when revoking access for a specific api key after confirming the correct key id.

Action Parameters

key_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download API keys

Description

Tool to download all api keys under an account in csv format. use when you need a complete list of api keys for export or backup.

Action Parameters

limit
integerDefaults to 1000
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all API keys

Description

Tool to retrieve all api keys under an account. use after authentication when you need to list api keys with pagination and sorting.

Action Parameters

limit
integer
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get API key by ID

Description

Tool to get an api key by key id. use when retrieving details of a specific api key after identifying its id.

Action Parameters

key_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reset API key by ID

Description

Tool to reset an api key by key id. use when you need to regenerate the secret for an api key after compromise or rotation.

Action Parameters

key_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update API key by ID

Description

Tool to update an api key by its id. use when you need to modify name, role, or enabled state after confirming the api key's identifier.

Action Parameters

account_id
integer
created_at
string
is_enabled
boolean
key_id
integerRequired
name
stringRequired
role
stringRequired
updated_at
string
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Change API key status by ID

Description

Tool to enable or disable an api key by its id. use when you need to toggle the activation state of an existing api key after retrieving its identifier.

Action Parameters

key_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all connections

Description

Tool to get all connections. use after authenticating when you need to list connections with pagination and sorting.

Action Parameters

limit
integer
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create API Key

Description

Tool to create a new api key. use when you need to provision access credentials for the api.

Action Parameters

is_enabled
boolean
name
stringRequired
role
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get dashboard reports and usage

Description

Tool to fetch account reports like pages used by agent, date, and product. use when analyzing usage over a date range.

Action Parameters

end
string
start
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get agent input by ID

Description

Tool to get agent input by agent id. use when you need to inspect or validate an agent's current input configuration before updating or starting jobs.

Action Parameters

agent_id
stringRequired

Action Response

collection
integer
data
array
error
string
field
string
id
string
successful
booleanRequired
type
stringRequired

Tool Name: Update Input by Agent ID

Description

Tool to update agent input by agent id. use when you need to modify an agent's input source (url, manual data, list, or agent) after verifying the agent id.

Action Parameters

agent_id
stringRequired
collection
integerDefaults to 1
data
array
field
string
id
string
type
stringRequired

Action Response

collection
integer
data
array
error
string
field
string
id
string
successful
booleanRequired
type
stringRequired

Tool Name: Download jobs

Description

Tool to download all jobs in csv format. use when you need a complete list of jobs for export or analysis.

Action Parameters

agent_id
string
limit
integerDefaults to 1000
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download job file by ID

Description

Tool to download output files by job id. use when you need to fetch a specific output file after a job completes.

Action Parameters

job_id
integerRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download Job Result by ID

Description

Tool to download the agent output result by job id. use when you need to fetch the final output of a completed job in csv, tsv, or json format.

Action Parameters

collection
integerDefaults to 1
format
stringRequired
job_id
integerRequired
limit
integerDefaults to 1000
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch all jobs

Description

Tool to fetch all jobs under an account. use when you need to view and filter the list of jobs with pagination and sorting.

Action Parameters

agent_id
string
limit
integer
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Job by ID

Description

Tool to fetch details of a specific job by its id. use when you need the full job metadata before retrieving results.

Action Parameters

job_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Job Logs by ID

Description

Tool to fetch logs for a given job by its id. use when you need to review or debug job execution logs with pagination support.

Action Parameters

job_id
stringRequired
limit
integerDefaults to 2500
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List job files by ID

Description

Tool to list output files by job id. use after job completion when you need to discover available output files.

Action Parameters

job_id
integerRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Start Agent Job

Description

Tool to start a new agent job. use when you need to trigger execution of an existing agent.

Action Parameters

agent_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Stop Job by ID

Description

Tool to stop a running job by job id. use when you need to halt an in-progress job before it completes. confirm the job id beforehand to avoid unintended stops.

Action Parameters

job_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Clear List Rows

Description

Tool to clear all rows in a list by its id. use when you need to wipe out all data in a list before re-populating (e.g., "clear all rows in list 123").

Action Parameters

list_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create List

Description

Tool to create a new list. use after preparing the list name and optional description. example: "create a list named 'contacts' with description 'potential leads'."

Action Parameters

description
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete List by ID

Description

Tool to delete a specific list by its id. use when you need to permanently remove a list after confirming it exists.

Action Parameters

list_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download lists

Description

Tool to download all lists in csv format. use when you need a complete set of lists for export or backup.

Action Parameters

limit
integerDefaults to 1000
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all lists

Description

Tool to retrieve all lists under an account. use after authentication when you need to list lists with pagination and sorting.

Action Parameters

limit
integer
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch List Rows by ID

Description

Tool to fetch all rows in a specified list. use when you need to retrieve all data entries from a list with optional pagination and sorting. example: "fetch rows from list '61db...' with limit=50".

Action Parameters

limit
integer
list_id
stringRequired
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update List by ID

Description

Tool to update a list's name or description by list id. use when you need to modify list metadata after confirming its id. example: "update list 123 with name 'my list'".

Action Parameters

description
string
list_id
integerRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload CSV file to List

Description

Tool to upload a csv file to a list. use when you need to bulk import rows into an existing list after verifying the list's column schema.

Action Parameters

file
stringRequired
list_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Agents to Project

Description

Tool to add agent(s) to a project. use after confirming the project exists and you have valid agent ids. example: "add agents ['agent abc123','agent xyz789'] to project 123."

Action Parameters

agent_ids
arrayRequired
project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Project

Description

Tool to create a new project. use when you need to initialize a project with a name and optional description or template.

Action Parameters

description
string
name
stringRequired
template
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all projects

Description

Tool to retrieve all projects under an account. use after authentication when you need to list projects with pagination and sorting.

Action Parameters

limit
integer
offset
integer
order
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired