Agenty

Integrate Agenty with your AI workspace

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

Explore Triggers and Actions

Add Agents to Project

Add one or more agents to an Agenty project to organize and group related agents together. This action associates agents with a project, allowing better organization and management of your automation workflows. The response includes the complete updated project information with all associated agents. Prerequisites: - Project must exist (use projects_get_all to find valid project IDs) - Agent(s) must exist (use agents_get_all to find valid agent IDs) Example usage: "Add agents ['tx8lubfbun', 'o3xuc2n8es'] to project 7"

ActionTry it

Add List Rows

Tool to add new rows to a list. Use when you need to insert one or more data rows into an existing list. Column names in row objects must match the list's schema.

ActionTry it

Capture Screenshot

Tool to capture a full-page or visible screenshot of any webpage URL. Use when you need to capture visual representation of a webpage as an image file. The screenshot is captured using browser automation with default settings.

ActionTry it

Capture Screenshot with Options

Tool to capture webpage screenshots with extensive customization options including full-page capture, image format, quality settings, viewport configuration, and post-processing. Use when you need to take screenshots of web pages with specific requirements for size, format, or rendering behavior.

ActionTry it

Change API key status by ID

Toggles the enabled/disabled status of an API key. This endpoint switches the key between enabled and disabled states - if the key is currently enabled, it will be disabled, and vice versa. Returns a confirmation message upon successful status change. Use this after retrieving the key_id from the list or get API key endpoints.

ActionTry it

Clear List Rows

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").

ActionTry it

Convert URL to PDF

Tool to convert a webpage URL to a PDF document. Use when you need to generate a PDF file from a web page for archival, reporting, or offline viewing purposes.

ActionTry it

Convert URL to PDF with Options

Tool to convert a URL or raw HTML to PDF with customizable options. Use when you need to generate PDFs with specific formatting requirements like custom page sizes, margins, headers/footers, or orientation. Supports both URL-based and HTML content conversion.

ActionTry it

Copy Agent

Tool to copy an existing agent by its ID, creating a duplicate with optionally a new name. Use when you need to duplicate an agent's configuration to create a similar agent without starting from scratch.

ActionTry it

Create Agent

Creates a new Agenty agent for web scraping, change detection, crawling, map monitoring, or brand monitoring. Use this tool to set up automated data extraction agents. Requires: - name: A descriptive name for the agent - type: One of 'scraping', 'changedetection', 'crawling', 'mapmonitoring', 'brandmonitoring' - config: Configuration object with url, browser, and collections defining what data to extract The config.collections array contains field definitions with CSS selectors or other extraction methods. Each field specifies what data to extract and how (TEXT content, ATTR for attributes, etc.). Optional: Set start=true to immediately run the agent after creation, or configure a scheduler for recurring runs. Returns the created agent with its unique agent_id for future reference.

ActionTry it

Create API Key

Creates a new API key for programmatic access to the Agenty API. The generated API key can be used to authenticate API requests with different permission levels (Owner, Admin, or Manager). The key is returned in the response and should be securely stored as it provides access to your Agenty account.

ActionTry it

Create List

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'."

ActionTry it

Create Project

Creates a new project in Agenty. Use this to initialize a project with a name and optional description.

ActionTry it

Create Workflow

Creates a new workflow in Agenty to automate actions based on agent events. Use this to set up automated responses like sending emails, triggering webhooks, or notifications when specific agent events occur (e.g., job completed, job failed).

ActionTry it

Delete Agent by ID

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

ActionTry it

Delete API key by ID

Delete an API key by its unique identifier. Use this tool to permanently revoke access for a specific API key. The key_id can be obtained from the "Get all API keys" or "Create API key" actions. This action cannot be undone.

ActionTry it

Delete List by ID

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

ActionTry it

Delete List Row by ID

Tool to delete a specific row from a list by its unique identifier. Use when you need to permanently remove a single row from a list.

ActionTry it

Delete List Rows by IDs

Tool to delete specific rows from a list by their IDs. Use when you need to remove one or more rows from a list by providing their unique identifiers.

ActionTry it

Delete Project

Tool to delete a project by its ID. Use when you need to permanently remove a project. This action cannot be undone, so ensure the project ID is correct before deletion.

ActionTry it

Delete Schedule

Tool to delete a schedule for an agent by its agent ID. Use when you need to remove scheduled automation for a specific agent.

ActionTry it

Delete Workflow by ID

Tool to delete a workflow by its ID. Use when you need to permanently remove a workflow after confirming it exists.

ActionTry it

Download Agent Result

Tool to download agent results by agent ID in CSV, TSV or JSON format. Use when you need to export or analyze agent execution results as a file.

ActionTry it

Download API keys

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.

ActionTry it

Download job file by ID

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

ActionTry it

Download Job Result by ID

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.

ActionTry it

Download jobs

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

ActionTry it

Download List Rows

Tool to download list rows as CSV file. Use when you need to export or backup all rows from a specific list.

ActionTry it

Download lists

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

ActionTry it

Download users

Tool to download users list in CSV format. Use when you need to export or backup the complete list of team members and users.

ActionTry it

Download workflows

Tool to download all workflows in CSV format. Use when you need to export or backup all workflows from your account.

ActionTry it

Extract Structured Data

Tool to auto-extract structured data from a webpage including schema.org, RDFa, Microdata, and JSON-LD formats. Use when you need to automatically extract semantic markup from web pages without writing custom scraping rules. The API returns organized structured data in four categories: metatags, microdata, rdfa, and jsonld.

ActionTry it

Extract Structured Data from URL

Tool to auto-extract structured data from a webpage URL. Use when you need to extract schema.org, RDFa, Microdata, or JSON-LD structured data from web pages.

ActionTry it

Fetch all agents

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

ActionTry it

Fetch all jobs

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

ActionTry it

Fetch List Rows by ID

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".

ActionTry it

Get Agent by ID

Retrieves complete details of a specific agent including its configuration, input settings, scheduler, and metadata. Use this tool when you need to: - View full agent configuration and settings - Check agent type and current version - Access scheduler and script configurations - Verify agent status before executing jobs - Retrieve agent metadata for updates or cloning

ActionTry it

Get agent input by ID

Retrieves the input configuration for a specific agent by its ID. Returns the input source type (URL, manual list, saved list reference, or another agent's output) and associated configuration details. Use this to inspect an agent's current input setup before modifying it or starting a job, or to verify what data sources an agent will process.

ActionTry it

Get Agent Result

Tool to get the most recent result data for an agent. Use when you need to retrieve and view the scraped/collected data from an agent's latest execution. Returns result data with pagination support.

ActionTry it

Get Agent Schedule

Tool to retrieve the schedule configuration for a specific agent. Use when you need to check the current scheduling settings for an agent.

ActionTry it

Get Agent Templates

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

ActionTry it

Get all API keys

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

ActionTry it

Get all connections

Retrieves all connections from your Agenty account. Supports pagination via limit/offset and sorting by field name. Returns an empty list if no connections exist.

ActionTry it

Get all lists

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

ActionTry it

Get all projects

Retrieve all projects in the authenticated user's account. Returns a paginated list of projects with metadata (total count, pagination info). Use this to discover available projects, check project existence, or get project IDs for other operations. Supports sorting by fields like 'name' or 'created_at'.

ActionTry it

Get all team members

Tool to retrieve all team members (users) under an account. Use after authentication when you need to list team members with pagination, sorting, and search filtering.

ActionTry it

Get API key by ID

Retrieves detailed information about a specific API key by its ID. Use this action when you need to: - Get the full details of an API key including its value, role, and status - Verify the existence and properties of a specific API key - Check if an API key is enabled or disabled The key_id can be obtained from the 'Get all API keys' action or when creating a new API key.

ActionTry it

Get dashboard reports and usage

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

ActionTry it

Get Job by ID

Retrieves comprehensive details about a specific job including its status, progress metrics (pages processed/succeeded/failed), timing information (created/started/completed times), resource consumption (page credits), and any error messages. Use this action to check job status, monitor execution progress, or diagnose job failures. Returns complete job metadata needed before downloading results.

ActionTry it

Get Job Logs by ID

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.

ActionTry it

Get Job Result

Tool to get the result data from a completed job. Use when you need to retrieve and view the scraped/collected data from a finished job. Returns result data with pagination support.

ActionTry it

Get list by ID

Retrieves detailed information about a specific list by its ID. Use this action when you need to: - Get the full details of a list including its name, description, and metadata - Verify the existence of a specific list - Check when a list was created or last updated - Access additional data associated with a list The list_id can be obtained from the 'Get all lists' action or when creating a new list.

ActionTry it

Get List Row by ID

Tool to fetch a specific row by its ID from a list. Use when you need to retrieve a single data entry from a list using its unique identifier.

ActionTry it

Get Page Content

Tool to fetch the complete HTML content of any webpage URL. Use this when you need to retrieve the full HTML source code of a page, including content rendered after JavaScript execution. The API navigates to the URL using proxies and captures the page's source content.

ActionTry it

Get Page Content with Options

Tool to fetch HTML content of a webpage with custom options including ad blocking. Use this when you need to retrieve the full HTML source of a webpage, particularly for web scraping or content analysis tasks. The tool supports ad blocking to speed up page loads and reduce unnecessary content.

ActionTry it

Get Project by ID

Retrieves complete details of a specific project by its ID, including name, description, creator information, and timestamps. Use this to get project metadata before adding agents, checking project existence, or verifying project details for updates.

ActionTry it

Get Redirects with Options

Tool to get the complete redirect chain of a URL with custom navigation options. Use when you need to trace URL redirects including both server-side (3xx) and client-side redirects (JavaScript, meta tags). Supports custom timeout and navigation wait conditions to ensure all redirects are captured.

ActionTry it

Get URL Redirects

Tool to get the complete redirect chain for a URL. Use when you need to trace how a URL redirects, including both server-side (HTTP 3xx redirects) and client-side redirects (JavaScript, meta tags). Returns an ordered list of all redirect steps from the original URL to the final destination.

ActionTry it

Get User by ID

Tool to retrieve detailed information about a user by their ID. Use this to fetch user profile data including email, role, status, and activity timestamps.

ActionTry it

Get Workflow by ID

Retrieves complete details of a specific workflow by its ID. Use this to view workflow configuration including agents, triggers, and actions before updating or deleting.

ActionTry it

List job output files

Lists all output files generated by a specific job. Returns file names and sizes for available downloads including CSV/JSON/TSV data exports and compressed logs. Use this after a job completes to discover what output files are available before downloading them.

ActionTry it

Patch Workflow

Tool to partially update a workflow by ID. Use when you need to update specific fields of a workflow without replacing the entire workflow object. This action performs a PATCH operation, allowing you to update only the fields you specify (e.g., just the name) without affecting other workflow properties. Currently supports updating the workflow name.

ActionTry it

Remove Agent from Project

Remove an agent from an Agenty project. Use when you need to disassociate an agent from a project while keeping both the agent and project intact. The agent will no longer be part of the project's organization structure.

ActionTry it

Reset API key by ID

Resets (regenerates) the secret value of an existing API key. The old secret becomes invalid immediately. Important: This action only confirms the reset was successful but does NOT return the new secret. After resetting, use the 'Get API Key By ID' action to retrieve the new secret value. Use this when you need to: - Rotate API key secrets for security - Invalidate a compromised API key and generate a new secret - Update credentials as part of security maintenance

ActionTry it

Scrape Webpage Data

Tool to scrape data from any webpage using jQuery/CSS selectors. Use when you need to extract specific data from web pages by defining jQuery selector expressions. Each query field maps a name to a jQuery expression (e.g., "$('h1').text()" extracts the h1 text). The browser will load the page, execute JavaScript, and run your jQuery queries to extract the data.

ActionTry it

Start Agent Job

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

ActionTry it

Stop Job by ID

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.

ActionTry it

Toggle Agent Schedule

Tool to toggle schedule on/off for an agent. Use when you need to enable or disable an agent's scheduled execution without modifying other agent settings.

ActionTry it

Transfer Agent Ownership

Tool to transfer agent ownership to another Agenty account. Use when you need to move an agent to a different user's account by specifying their email address.

ActionTry it

Update Agent by ID

Updates an existing agent's configuration, settings, and metadata. Use this tool to modify an agent's properties such as name, type, config, tags, scheduler, scripts, or visibility settings. The API only returns the fields that were updated in the response, not the complete agent object. To get the full updated agent details, use the 'Get Agent by ID' action after updating. Example uses: - "Update agent abc123 to change its name to 'Production Scraper'" - "Enable scheduling for agent xyz789 with a cron expression '0 */6 * * *'" - "Update agent def456 config to scrape a different URL"

ActionTry it

Update Agent Schedule

Updates the schedule configuration for a specific agent. Use when you need to modify how often an agent runs automatically.

ActionTry it

Update API key by ID

Updates an existing API key's name and role by its unique identifier. This action allows you to modify the display name and permission level of an API key. Only the name and role fields can be updated; other properties are read-only. After updating, the action automatically fetches and returns the complete updated API key details. Use this when you need to: - Rename an API key for better identification - Change the permission level (Owner, Admin, or Manager) of an API key - Update multiple properties of an API key at once

ActionTry it

Update Input by Agent ID

Updates the input configuration for a specific agent in Agenty. This tool modifies where an agent gets its input data from. You can configure the agent to: - Pull from a URL feed (type='url') - Use a manually specified list of URLs (type='manual') - Reference data from an Agenty list (type='list') - Use output from another agent (type='agent') Use this after creating or identifying an agent to set up its data source before running jobs.

ActionTry it

Update List by ID

Tool to update a list's name and optionally description by list ID. The name field is always required. Use when you need to modify list metadata after confirming its ID. Example: "Update list 123 with name 'My Updated List' and description 'New description'".

ActionTry it

Update List Row

Tool to update a specific row in a list by list ID and row ID. Use when you need to modify existing data in a list row. The row_data must include the '_id' field and any column fields (col1, col2, etc.) you want to update.

ActionTry it

Update Project

Update an existing project's name and description in Agenty. Use this to modify project details such as changing the project name or updating its description.

ActionTry it

Update User by ID

Tool to update a user's information by user ID. Use this to modify user properties including email, role, status, name, and subscription settings. Email, role, and status are required fields.

ActionTry it

Update Workflow

Tool to update an existing workflow's configuration by workflow ID. Use this to modify workflow properties including name, agent selection, trigger conditions, and actions to execute. Workflows automate responses to agent events such as job completion, errors, or change detection. Common use cases include sending notifications, triggering webhooks, or updating external systems.

ActionTry it

Upload CSV file to List

Tool to upload a CSV file to an Agenty list for bulk import of data rows. Use this action when you need to: - Import multiple rows of data into an existing list from a CSV file - Bulk update list data - Add structured tabular data to a list Prerequisites: The target list must already exist. Use the 'Create List' action first if needed.

ActionTry it