Skip to main content
Agenty logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 79
  • Triggers: 0
  • Slug: AGENTY
  • Version: 20261101_00

Tools

Slug: AGENTY_ADD_LIST_ROWSTool 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.

Input Parameters

array
required
Array of row objects to insert into the list. Each row object contains column name-value pairs. Column names must match the list’s predefined columns for automatic mapping. Example: [{‘col1’: ‘Test Row 1’, ‘col2’: ‘Value A’}]
string
required
Unique identifier of the list to add rows to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_AGENTS_CONTROLLER_CREATE_AGENTCreates 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.

Input Parameters

string
Icon URL for the agent (e.g., favicon URL). Auto-generated from target URL if not provided
string
required
Agent name, max 100 characters
array
List of tag strings for categorizing and searching agents (e.g., [‘demo’, ‘production’])
string ("scraping" | "changedetection" | "crawling" | "mapmonitoring" | "brandmonitoring")
required
Agent type: ‘scraping’ for web scraping, ‘changedetection’ for monitoring page changes, ‘crawling’ for site crawling, ‘mapmonitoring’ for map data, ‘brandmonitoring’ for brand mentions
boolean
Whether to automatically start the agent job immediately after creation. Default: false
object
required
Agent configuration with url, browser, and collections array. Each collection requires a ‘name’ and ‘fields’ array with field definitions for data extraction
object
Optional JavaScript scripts to execute before (pre) or after (post) agent execution
integer
User ID for the agent owner (usually auto-set from authenticated user)
integer
Version number for the agent. Auto-set to 1 for new agents if not provided
string
Custom agent ID (alphanumeric). If not provided, server auto-generates one
boolean
Whether the agent is publicly accessible/shareable. Default: false
object
Optional scheduler to run agent automatically at specified intervals or cron schedule
integer
Account ID for the agent (usually auto-set from authenticated user)
string
ISO 8601 timestamp when agent was created. Auto-set by server
boolean
Whether the agent is managed by Agenty system. Typically false for user-created agents
integer
Project ID to organize the agent under a specific project. Leave empty for no project assignment
string
ISO 8601 timestamp when agent was last updated. Auto-set by server
string
Description of the agent, max 1000 characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_AGENTS_CONTROLLER_GET_TEMPLATESTool to fetch all public agent templates and sample agents. Use when listing available templates for users to select.

Input Parameters

string
Field name to sort by.
integer
Maximum number of items to return. Default is 1000.
string ("asc" | "desc")
Sort direction: ‘asc’ or ‘desc’.
integer
Number of items to skip. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_AGENTS_DELETE_BY_IDTool to delete a single agent by its ID. Use when you need to permanently remove an agent after confirming it exists.

Input Parameters

string
required
Unique identifier of the agent to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_AGENTS_GET_ALLTool to fetch all active agents under an account. Use after authenticating when you need to list agents with pagination and sorting.

Input Parameters

string
Field by which to sort the results, e.g., ‘name’ or ‘created_at’.
integer
Maximum number of records to return.
string ("asc" | "desc")
Order of sorting; possible values are ‘asc’ (ascending) and ‘desc’ (descending).
integer
Number of records to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_AGENTS_GET_BY_IDRetrieves 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

Input Parameters

string
required
The unique identifier of the agent to retrieve. You can obtain agent IDs from the agents_get_all action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_AGENTS_UPDATE_BY_IDUpdates an existing agent’s configuration, settings, and metadata by ID. The request requires the agent’s name, type, and configuration, and can include tags, scheduler, scripts, and visibility settings.

Input Parameters

string
URL or identifier for the agent icon.
string
required
Agent name (max 100 characters).
array
List of tags for categorization.
string ("scraping" | "changedetection" | "crawling" | "mapmonitoring" | "brandmonitoring")
required
Agent type.
object
required
Agent configuration object containing scraping/crawling settings. Must include ‘url’ (target URL), ‘browser’ (e.g., ‘playwright’), and ‘collections’ (array of data collection rules with fields to extract). Additional properties vary by agent type.
object
Optional pre/post execution scripts.
integer
User ID that created or owns this agent.
integer
Agent version number.
string
required
Unique identifier of the agent to update.
boolean
Whether the agent is publicly visible.
object
Optional scheduling settings.
integer
Account ID that owns this agent.
string
ISO timestamp when the agent was created.
boolean
Whether the agent is managed by Agenty.
integer
Project ID under which the agent is grouped.
string
ISO timestamp when the agent was last updated.
string
Agent description (max 1000 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_CONTROLLER_CREATE_API_KEYSCreates 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.

Input Parameters

string
required
Name of the API key (must be at least 1 character)
string ("Owner" | "Admin" | "Manager")
required
Role to assign to the API key. Must be one of: Owner, Admin, or Manager
boolean
Whether the API key should be enabled upon creation. Defaults to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_DELETE_BY_IDDelete 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.

Input Parameters

string
required
Unique identifier of the API key to delete. This is the numeric ID returned when creating or listing API keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_DOWNLOADDownloads API keys under an account as CSV text, with pagination and sorting options. Each request is limited to at most 1,000 items.

Input Parameters

string
Field name to sort by
integer
Maximum number of items to return
string ("asc" | "desc")
Sort order: asc or desc
integer
Number of items to skip before starting to collect the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_GET_ALLTool to retrieve all API keys under an account. Use after authentication when you need to list API keys with pagination and sorting.

Input Parameters

string
Field by which to sort the results, e.g., ‘created_at’ or ‘name’
integer
Maximum number of API keys to return
string ("asc" | "desc")
Order of sorting: ‘asc’ (ascending) or ‘desc’ (descending)
integer
Number of API keys to skip before starting to return results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_GET_BY_IDRetrieves 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.

Input Parameters

integer
required
The unique numeric identifier of the API key to retrieve. Can be obtained from listing API keys or after creating a new API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_RESET_BY_IDResets (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

Input Parameters

integer
required
Unique identifier of the API key to reset. You can obtain this from the Get All API Keys or Get API Key By ID actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_API_KEYS_UPDATE_BY_IDUpdates an API key’s name and role by its ID, requiring both values. After updating, the tool fetches and returns the updated key details.

Input Parameters

string
required
Name of the API key. This is a display name used to identify the key
string ("Owner" | "Admin" | "Manager")
required
Role to assign to the API key. Valid options are: Owner (full access), Admin (administrative access), or Manager (management access)
integer
required
Unique identifier of the API key to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CAPTURE_SCREENSHOTTool 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.

Input Parameters

string
required
The URL of the webpage to capture as a screenshot. Must be a valid HTTP or HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CAPTURE_SCREENSHOT_WITH_OPTIONSTool 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.

Input Parameters

string
required
Target webpage URL to capture. Must be a valid HTTP or HTTPS URL.
string
HTML content to render instead of loading from a URL. Use when you want to screenshot custom HTML without a live webpage.
object
Configuration options for screenshot capture.
boolean
When true, blocks advertisement scripts and resources during page load. Defaults to false.
object
Browser viewport configuration for screenshot rendering.
object
Privacy and resource optimization options.
string
Custom user agent string to use for the request. Useful for emulating specific browsers or devices.
object
Image manipulation options for post-processing.
object
Navigation options for loading the target URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CHANGE_API_KEY_STATUS_BY_IDToggles 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.

Input Parameters

integer
required
ID of the API key to enable or disable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CONNECTIONS_GET_ALLRetrieves all connections from your Agenty account. Supports pagination via limit/offset and sorting by field name. Returns an empty list if no connections exist.

Input Parameters

string
Field name to sort results by. Common values: ‘name’, ‘created_at’, ‘updated_at’, ‘status’.
integer
Maximum number of connections to return in one request. Use for pagination to control page size.
string ("asc" | "desc")
Sort order direction. Use ‘asc’ for ascending (A-Z, oldest first) or ‘desc’ for descending (Z-A, newest first).
integer
Number of records to skip for pagination. Use with limit to paginate through results. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CONVERT_URL_TO_PDFTool 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.

Input Parameters

string
required
The webpage URL to convert to PDF document. Must be a valid HTTP or HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CONVERT_URL_TO_PDF_WITH_OPTIONSTool 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.

Input Parameters

string
URL of the webpage to convert to PDF. Either ‘url’ or ‘html’ must be provided.
string
Raw HTML content to convert to PDF. Either ‘url’ or ‘html’ must be provided.
integer ("90" | "-90" | "180")
PDF rotation angle in degrees.
object
PDF generation options.
object
Anonymous browsing options.
boolean
Whether to block ads on the page. Default is false.
string
Custom user agent string to use for the request.
object
Navigation options for page load.
string ("screen" | "print")
Media type to emulate when rendering the page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_COPY_AGENTTool 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.

Input Parameters

string
Name for the copied agent. If not provided, a default name will be generated based on the original agent name.
string
required
ID of the agent to copy. You can obtain agent IDs from the agents_get_all action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_CREATE_WORKFLOWCreates 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).

Input Parameters

string
required
Name of the workflow. Must be non-empty and maximum 200 characters.
object
required
Configuration specifying which agents should trigger this workflow. Set all=true to apply to all agents.
array
required
Array of actions to execute when the workflow is triggered. Each action must have a type and config object.
object
required
Trigger configuration defining when the workflow executes. Must include a ‘when’ array with at least one event type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DASHBOARD_GET_REPORTS_USAGETool to fetch account reports like pages used by agent, date, and product. Use when analyzing usage over a date range.

Input Parameters

string
End date in YYYY-MM-DD format (e.g., ‘2024-01-31’); defaults to today if omitted
string
Start date in YYYY-MM-DD format (e.g., ‘2024-01-01’); defaults to 30 days before today if omitted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DELETE_LIST_ROWTool 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.

Input Parameters

string
required
Unique identifier of the row to delete
string
required
Unique identifier of the list containing the row to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DELETE_LIST_ROWSTool 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.

Input Parameters

array
required
List of row IDs to delete. Each ID will be passed as a separate query parameter (e.g., ?id=xxx&id=yyy). At least one ID is required.
string
required
Unique identifier of the list containing the rows to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DELETE_PROJECTTool 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.

Input Parameters

string
required
The project identifier number to be deleted. This is the unique ID of the project you want to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DELETE_SCHEDULETool to delete a schedule for an agent by its agent ID. Use when you need to remove scheduled automation for a specific agent.

Input Parameters

string
required
Unique identifier of the agent whose schedule should be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DELETE_WORKFLOWTool to delete a workflow by its ID. Use when you need to permanently remove a workflow after confirming it exists.

Input Parameters

string
required
Unique identifier of the workflow to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DOWNLOAD_AGENT_RESULTDownloads agent results by agent ID as a CSV, TSV, or JSON file. Results are paginated, with a maximum of 1,000 records per request.

Input Parameters

string
Field name to sort results by
integer
Maximum 1000 results per request - number of results to return
string ("asc" | "desc")
Sort order options.
string ("CSV" | "TSV" | "JSON")
Output format for the downloaded file - must be CSV, TSV or JSON
integer
Pagination offset - number of results to skip before starting to collect the result set
Search filter to apply on results
string
required
The agent identifier whose results to download
integer
Collection number - which collection of results to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DOWNLOAD_LIST_ROWSDownloads rows from a specified list and returns the CSV content as text for export or backup.

Input Parameters

string
required
Unique identifier of the list to download rows from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DOWNLOAD_USERSDownload a page of the users list as CSV text, with offset, limit, and optional sorting. Multiple requests may be needed to export the complete list.

Input Parameters

string
Field name to sort by
integer
Maximum number of items to return
string ("asc" | "desc")
Sort order: asc or desc
integer
Number of items to skip before starting to collect the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_DOWNLOAD_WORKFLOWSTool to download all workflows in CSV format. Use when you need to export or backup all workflows from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_EXTRACT_BROWSER_STRUCTURED_DATATool 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.

Input Parameters

string
required
The webpage URL from which to extract structured data (schema.org, RDFa, Microdata, JSON-LD). Must be a valid HTTP/HTTPS URL.
object
Browser navigation settings for page load behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_EXTRACT_STRUCTURED_DATATool 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.

Input Parameters

string
required
The URL of the webpage from which to extract structured data (schema.org, RDFa, Microdata, JSON-LD). Must be a valid HTTP/HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_AGENT_RESULTTool 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.

Input Parameters

string
Field name to sort by.
integer
Maximum number of records to return (max 1000).
string ("asc" | "desc")
Sort order: asc for ascending or desc for descending.
integer
Number of records to skip before starting to return results.
string
Search term to filter results.
string
required
Unique identifier of the agent to get results for. You can obtain agent IDs from the agents_get_all action.
string
Collection name to filter results by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_ALL_TEAM_MEMBERSTool 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.

Input Parameters

string
Field by which to sort the results, e.g., ‘name’, ‘email’, or ‘created_at’.
integer
Maximum number of users to return. Maximum allowed is 1000.
string ("asc" | "desc")
Order of sorting: ‘asc’ (ascending) or ‘desc’ (descending).
integer
Number of users to skip before starting to return results. Used for pagination.
string
Search term to filter users by name or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_BROWSER_REDIRECTSTool 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.

Input Parameters

string
required
The URL to check for redirects. Must be a valid HTTP or HTTPS URL. The API will follow all redirects including server-side (3xx status codes) and client-side redirects (JavaScript, meta tags, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_JOB_RESULTTool 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.

Input Parameters

string
Field name to sort by.
integer
Maximum number of records to return (<=1000).
string ("asc" | "desc")
Sort order: asc for ascending or desc for descending.
string
Format for the result data.
integer
required
Unique identifier of the job to get result for. Get this from jobs_get_all or jobs_start actions.
integer
Number of records to skip before starting to return results.
string
Search term to filter results.
string
Collection name to filter results by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_LIST_BY_IDRetrieves 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.

Input Parameters

string
required
The unique identifier of the list to retrieve. Can be obtained from listing all lists or after creating a new list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_LIST_ROW_BY_IDTool 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.

Input Parameters

string
required
Unique identifier of the row to fetch (MongoDB ObjectId format)
string
required
Unique identifier of the list containing the row

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_PAGE_CONTENTTool 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.

Input Parameters

string
required
The URL of the webpage to fetch HTML content from. Must be a valid HTTP or HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_PAGE_CONTENT_WITH_OPTIONSTool 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.

Input Parameters

string
required
The webpage URL to fetch HTML content from. Must be a valid HTTP or HTTPS URL.
boolean
Whether to block advertisements on the page. Set to true to block ads, false to allow them. Defaults to true for faster page loads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_PROJECT_BY_IDRetrieves 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.

Input Parameters

integer
required
The unique identifier of the project to retrieve. You can obtain project IDs from the projects_get_all action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_REDIRECTS_WITH_OPTIONSTool 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.

Input Parameters

string
required
The URL to follow and get the complete redirect chain. Must be a valid HTTP or HTTPS URL.
object
Browser navigation settings for page load behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_SCHEDULETool to retrieve the schedule configuration for a specific agent. Use when you need to check the current scheduling settings for an agent.

Input Parameters

string
required
Unique identifier of the agent whose schedule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_USER_BY_IDTool to retrieve detailed information about a user by their ID. Use this to fetch user profile data including email, role, status, and activity timestamps.

Input Parameters

integer
required
The unique numeric identifier of the user to retrieve. This is the user’s ID in the Agenty system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_GET_WORKFLOW_BY_IDRetrieves complete details of a specific workflow by its ID. Use this to view workflow configuration including agents, triggers, and actions before updating or deleting.

Input Parameters

string
required
The unique identifier of the workflow to retrieve. This ID is returned when creating a workflow or can be obtained from listing workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_INPUTS_GET_BY_AGENT_IDRetrieves 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.

Input Parameters

string
required
Unique identifier of the agent to retrieve inputs for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_INPUTS_UPDATE_BY_AGENT_IDUpdates 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.

Input Parameters

string
Source identifier. For ‘url’: the URL string. For ‘list’: the list ID. For ‘agent’: the source agent ID. Not used for ‘manual’ type
array
List of URLs for manual input. Required and only used when type is ‘manual’. Each entry should be a valid URL string
string ("url" | "manual" | "list" | "agent")
required
Type of input source to configure. Options: ‘url’ (URL feed), ‘manual’ (direct URL list), ‘list’ (reference to a list), ‘agent’ (output from another agent)
string
Field name to extract from the source. Required for ‘list’ and ‘agent’ types to specify which field to use as input
string
required
Unique identifier of the agent whose input configuration to update
integer
Collection number to use (default: 1). Specifies which collection in the agent configuration to apply the input to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_DOWNLOADDownload a page of jobs in CSV format for export or analysis. Supports pagination, sorting, and filtering by agent; each request returns at most 1,000 jobs.

Input Parameters

string
Field name to sort by
integer
Maximum number of jobs to return
string ("asc" | "desc")
Sort order: asc or desc
integer
Number of jobs to skip before starting to collect the result set
string
Filter jobs to only those created by this agent ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_DOWNLOAD_FILES_BY_IDDownload a named output file by job ID and return its content as text. Use to fetch a specific output file after a job completes.

Input Parameters

string
required
Name of the specific file to download (e.g., ‘collection1.csv’, ‘logs.txt.gz’). Use the ‘List job files’ action first to discover available files.
integer
required
Unique identifier of the job to download files from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_DOWNLOAD_RESULT_BY_IDDownload a page of agent output results by job ID in CSV, TSV, or JSON format. Supports pagination, sorting, and collection selection, with a maximum of 1,000 items per request.

Input Parameters

string
Field name to sort by
integer
Maximum number of items to return
string ("asc" | "desc")
Sort order: asc or desc
string ("CSV" | "TSV" | "JSON")
required
Format of the downloaded file: CSV, TSV, or JSON
integer
required
Unique identifier of the job to download result for
integer
Number of items to skip before starting to collect the result set
integer
Result collection number to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_GET_ALLTool to fetch all jobs under an account. Use when you need to view and filter the list of jobs with pagination and sorting.

Input Parameters

string
Field by which to sort the results, e.g., ‘created_at’ or ‘status’.
integer
Maximum number of records to return (<=1000).
string ("asc" | "desc")
Order of sorting; either ‘asc’ for ascending or ‘desc’ for descending.
integer
Number of records to skip before starting to return results.
string
Filter jobs by specific agent identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_GET_BY_IDRetrieves 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.

Input Parameters

integer
required
The unique numeric identifier of the job to retrieve. Get this from jobs_get_all or jobs_start actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_GET_LOGS_BY_IDTool to fetch logs for a given job by its ID. Use when you need to review or debug job execution logs with pagination support.

Input Parameters

integer
Maximum number of log lines to return (pagination limit).
string
required
Unique identifier of the job to fetch logs for.
integer
Number of log lines to skip (pagination offset).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_LIST_FILES_BY_IDLists 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.

Input Parameters

integer
required
Unique numeric identifier of the job whose output files you want to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_STARTTool to start a new agent job. Use when you need to trigger execution of an existing agent.

Input Parameters

string
required
Unique identifier of the agent to start the job for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_JOBS_STOP_BY_IDTool 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.

Input Parameters

integer
required
Unique numeric identifier of the job to stop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_CLEAR_ROWSClear all rows in a list identified by a positive numeric list ID. Use to remove the list’s data before re-populating it.

Input Parameters

integer
required
Unique identifier of the list to clear rows from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_CONTROLLER_CREATE_LISTTool to create a new list. Use after preparing the list name and optional description. Example: “Create a list named ‘Contacts’ with description ‘Potential leads’.”

Input Parameters

string
required
Name of the list, max 100 characters
string
Description of the list, max 250 characters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_DELETE_BY_IDTool to delete a specific list by its ID. Use when you need to permanently remove a list after confirming it exists.

Input Parameters

integer
required
Unique identifier of the list to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_DOWNLOADDownload a page of lists as CSV text, with offset, limit, and optional sorting. Use successive offsets to export more lists.

Input Parameters

string
Field name to sort by
integer
Maximum number of items to return
string ("asc" | "desc")
Sort order: asc or desc
integer
Number of items to skip before starting to collect the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_GET_ALLTool to retrieve all lists under an account. Use after authentication when you need to list lists with pagination and sorting.

Input Parameters

string
Field by which to sort the results, e.g., ‘name’ or ‘created_at’.
integer
Maximum number of lists to return.
string ("asc" | "desc")
Order of sorting; possible values are ‘asc’ (ascending) and ‘desc’ (descending).
integer
Number of lists to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_GET_ROWS_BY_IDTool 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”.

Input Parameters

string
Column name to sort the results by
integer
Number of rows to return per request
string ("asc" | "desc")
Sort order, either ‘asc’ or ‘desc’
integer
Number of rows to skip before starting to return rows
string
required
Unique identifier of the list to fetch rows from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_UPDATE_BY_IDTool 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’”.

Input Parameters

string
required
Name for the list, max 100 characters. This field is required by the API.
integer
required
Unique identifier of the list to update
string
Description for the list, max 250 characters. This field is optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_LISTS_UPLOAD_CSVTool 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.

Input Parameters

object
required
CSV file to upload to the list.
integer
required
Unique identifier of the list to which the CSV will be uploaded. Must be a valid existing list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_PATCH_WORKFLOWTool 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.

Input Parameters

string
required
The unique identifier of the workflow to update. This is the workflow ID obtained from listing workflows or when the workflow was created.
string
New name for the workflow. Use this to rename the workflow for better identification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_PROJECTS_ADD_AGENTSAdd 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”

Input Parameters

array
required
List of agent IDs to add to the project (e.g., [‘tx8lubfbun’, ‘o3xuc2n8es’]). Must contain at least one agent ID.
integer
required
Unique identifier of the project to which agents will be added

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_PROJECTS_CONTROLLER_CREATE_PROJECTCreates a new project in Agenty. Use this to initialize a project with a name and optional description.

Input Parameters

string
required
Name of the project. Must be non-empty and maximum 64 characters.
string
Optional description of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_PROJECTS_GET_ALLRetrieve 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’.

Input Parameters

string
Field by which to sort the results, e.g., ‘name’ or ‘created_at’.
integer
Maximum number of projects to return.
string ("asc" | "desc")
Order of sorting; possible values are ‘asc’ (ascending) and ‘desc’ (descending).
integer
Number of projects to skip before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_REMOVE_AGENT_FROM_PROJECTRemove 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.

Input Parameters

string
required
Unique identifier of the agent to remove from the project
string
required
Unique identifier of the project from which the agent will be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_SCRAPE_WEBPAGE_DATATool 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.

Input Parameters

string
required
The webpage URL to scrape data from. Must be a valid HTTP or HTTPS URL.
object
Debug options to include additional information in the response.
object
required
jQuery-based extraction queries mapping field names to jQuery selector expressions. Each key is a field name, and each value is a jQuery expression like ”$(‘h1’).text()” or ”$(‘a’).attr(‘href’)”. The expressions will be executed in the browser context to extract data.
boolean
Whether to block advertisements on the page. Default is true.
string
Custom user agent string to use when making the request. If not provided, uses the browser’s default user agent.
object
Browser navigation settings for page load behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_TOGGLE_SCHEDULETool 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.

Input Parameters

boolean
required
Set to true to enable the agent’s schedule, or false to disable it.
string
required
Unique identifier of the agent whose schedule should be toggled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_TRANSFER_AGENT_OWNERSHIPTool 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.

Input Parameters

string
required
Email address of the target Agenty account to transfer the agent to. The email must be associated with an existing Agenty account.
string
required
The unique identifier of the agent to transfer. You can obtain agent IDs from the agents_get_all action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_UPDATE_LIST_ROWTool 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.

Input Parameters

string
required
Unique identifier of the row to update within the list
string
required
Unique identifier of the list containing the row to update
object
required
JSON object containing the row data to update. Must include ‘_id’ field matching the row ID. Column fields (col1, col2, col3, etc.) correspond to columns in the list. Example: {‘_id’: ‘698dc77d125553af8b7c5700’, ‘col1’: ‘Updated Value’, ‘col2’: ‘Another Value’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_UPDATE_PROJECTUpdate an existing Agenty project’s name and optionally its description by project ID. A name is required even when updating the description.

Input Parameters

string
required
Unique identifier of the project to update.
string
required
Name of the project. Required field that must be non-empty and maximum 64 characters.
string
Description of the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_UPDATE_SCHEDULEUpdates the schedule configuration for a specific agent. Use when you need to modify how often an agent runs automatically.

Input Parameters

string ("cron" | "interval")
required
Schedule type: ‘cron’ for cron expression-based scheduling or ‘interval’ for frequency-based scheduling.
string
required
Unique identifier of the agent whose schedule to update.
integer
Frequency value in seconds for interval-based scheduling (e.g., 3600 for hourly). Required when type is ‘interval’.
string
Cron expression for cron-based scheduling (e.g., ‘0 0 12 * * ?’ for daily at noon). Required when type is ‘cron’. Must be a valid CRON expression.
boolean
Enable or disable the schedule. When false, the schedule exists but will not trigger the agent.
string
Human-readable description of the schedule. This is typically auto-generated by Agenty based on the cron expression or frequency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_UPDATE_USER_BY_IDTool 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.

Input Parameters

string
User’s full name
string ("Owner" | "Admin" | "Manager")
required
User role. Valid options are: Owner (full access), Admin (administrative access), or Manager (management access).
string
required
User email address. Must be a valid email format.
string
URL of the user’s avatar image
string ("active" | "inactive")
required
User status. Must be either ‘active’ or ‘inactive’.
string
required
Unique identifier of the user to update
boolean
Whether the user’s email address has been verified
boolean
Whether the user is subscribed to receive email notifications

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENTY_UPDATE_WORKFLOWUpdate a workflow by ID with its name, agent scope, trigger conditions, and actions. The agent scope accepts an all-agents flag; the update requires the full listed configuration.

Input Parameters

string
required
Unique identifier of the workflow to update.
string
required
Updated name for the workflow (e.g., ‘Send Email on Job Completion’).
object
required
Configuration specifying which agents this workflow applies to.
array
required
Array of actions to execute when the workflow is triggered. Must contain at least one action.
object
required
Trigger configuration defining when this workflow should execute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not