# Agenty

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

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 79
- **Triggers:** 0
- **Slug:** `AGENTY`
- **Version:** 20260312_00

## Tools

### Add List Rows

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rows` | array | Yes | 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'}] |
| `list_id` | string | Yes | Unique identifier of the list to add rows to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Agent

**Slug:** `AGENTY_AGENTS_CONTROLLER_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Agent Templates

**Slug:** `AGENTY_AGENTS_CONTROLLER_GET_TEMPLATES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by. |
| `limit` | integer | No | Maximum number of items to return. Default is 1000. |
| `order` | string ("asc" | "desc") | No | Sort direction: 'asc' or 'desc'. |
| `offset` | integer | No | Number of items to skip. Default is 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Agent by ID

**Slug:** `AGENTY_AGENTS_DELETE_BY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Unique identifier of the agent to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch all agents

**Slug:** `AGENTY_AGENTS_GET_ALL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field by which to sort the results, e.g., 'name' or 'created_at'. |
| `limit` | integer | No | Maximum number of records to return. |
| `order` | string ("asc" | "desc") | No | Order of sorting; possible values are 'asc' (ascending) and 'desc' (descending). |
| `offset` | integer | No | Number of records to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Agent by ID

**Slug:** `AGENTY_AGENTS_GET_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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | The unique identifier of the agent to retrieve. You can obtain agent IDs from the agents_get_all action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Agent by ID

**Slug:** `AGENTY_AGENTS_UPDATE_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"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | URL or identifier for the agent icon. |
| `name` | string | Yes | Agent name (max 100 characters). |
| `tags` | array | No | List of tags for categorization. |
| `type` | string ("scraping" | "changedetection" | "crawling" | "mapmonitoring" | "brandmonitoring") | Yes | Agent type. |
| `config` | object | Yes | 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. |
| `scripts` | object | No | Optional pre/post execution scripts. |
| `user_id` | integer | No | User ID that created or owns this agent. |
| `version` | integer | No | Agent version number. |
| `agent_id` | string | Yes | Unique identifier of the agent to update. |
| `is_public` | boolean | No | Whether the agent is publicly visible. |
| `scheduler` | object | No | Optional scheduling settings. |
| `account_id` | integer | No | Account ID that owns this agent. |
| `created_at` | string | No | ISO timestamp when the agent was created. |
| `is_managed` | boolean | No | Whether the agent is managed by Agenty. |
| `project_id` | integer | No | Project ID under which the agent is grouped. |
| `updated_at` | string | No | ISO timestamp when the agent was last updated. |
| `description` | string | No | Agent description (max 1000 characters). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create API Key

**Slug:** `AGENTY_API_KEYS_CONTROLLER_CREATE_API_KEYS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the API key (must be at least 1 character) |
| `role` | string ("Owner" | "Admin" | "Manager") | Yes | Role to assign to the API key. Must be one of: Owner, Admin, or Manager |
| `is_enabled` | boolean | No | Whether the API key should be enabled upon creation. Defaults to true |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete API key by ID

**Slug:** `AGENTY_API_KEYS_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_id` | string | Yes | Unique identifier of the API key to delete. This is the numeric ID returned when creating or listing API keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download API keys

**Slug:** `AGENTY_API_KEYS_DOWNLOAD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by |
| `limit` | integer | No | Maximum number of items to return |
| `order` | string ("asc" | "desc") | No | Sort order: asc or desc |
| `offset` | integer | No | Number of items to skip before starting to collect the result set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all API keys

**Slug:** `AGENTY_API_KEYS_GET_ALL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field by which to sort the results, e.g., 'created_at' or 'name' |
| `limit` | integer | No | Maximum number of API keys to return |
| `order` | string ("asc" | "desc") | No | Order of sorting: 'asc' (ascending) or 'desc' (descending) |
| `offset` | integer | No | Number of API keys to skip before starting to return results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get API key by ID

**Slug:** `AGENTY_API_KEYS_GET_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset API key by ID

**Slug:** `AGENTY_API_KEYS_RESET_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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update API key by ID

**Slug:** `AGENTY_API_KEYS_UPDATE_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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the API key. This is a display name used to identify the key |
| `role` | string ("Owner" | "Admin" | "Manager") | Yes | Role to assign to the API key. Valid options are: Owner (full access), Admin (administrative access), or Manager (management access) |
| `key_id` | integer | Yes | Unique identifier of the API key to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Capture Screenshot

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the webpage to capture as a screenshot. Must be a valid HTTP or HTTPS URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Capture Screenshot with Options

**Slug:** `AGENTY_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change API key status by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_id` | integer | Yes | ID of the API key to enable or disable |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all connections

**Slug:** `AGENTY_CONNECTIONS_GET_ALL`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert URL to PDF

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webpage URL to convert to PDF document. Must be a valid HTTP or HTTPS URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert URL to PDF with Options

**Slug:** `AGENTY_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Agent

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name for the copied agent. If not provided, a default name will be generated based on the original agent name. |
| `agent_id` | string | Yes | ID of the agent to copy. You can obtain agent IDs from the agents_get_all action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workflow

**Slug:** `AGENTY_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).

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get dashboard reports and usage

**Slug:** `AGENTY_DASHBOARD_GET_REPORTS_USAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | End date in YYYY-MM-DD format (e.g., '2024-01-31'); defaults to today if omitted |
| `start` | string | No | Start date in YYYY-MM-DD format (e.g., '2024-01-01'); defaults to 30 days before today if omitted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List Row by ID

**Slug:** `AGENTY_DELETE_LIST_ROW`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the row to delete |
| `list_id` | string | Yes | Unique identifier of the list containing the row to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List Rows by IDs

**Slug:** `AGENTY_DELETE_LIST_ROWS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | array | Yes | 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. |
| `list_id` | string | Yes | Unique identifier of the list containing the rows to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project identifier number to be deleted. This is the unique ID of the project you want to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Schedule

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Unique identifier of the agent whose schedule should be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workflow by ID

**Slug:** `AGENTY_DELETE_WORKFLOW`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | Unique identifier of the workflow to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Agent Result

**Slug:** `AGENTY_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download List Rows

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | Unique identifier of the list to download rows from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download users

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by |
| `limit` | integer | No | Maximum number of items to return |
| `order` | string ("asc" | "desc") | No | Sort order: asc or desc |
| `offset` | integer | No | Number of items to skip before starting to collect the result set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download workflows

**Slug:** `AGENTY_DOWNLOAD_WORKFLOWS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Structured Data

**Slug:** `AGENTY_EXTRACT_BROWSER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webpage URL from which to extract structured data (schema.org, RDFa, Microdata, JSON-LD). Must be a valid HTTP/HTTPS URL. |
| `gotoOptions` | object | No | Browser navigation settings for page load behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Structured Data from URL

**Slug:** `AGENTY_EXTRACT_STRUCTURED_DATA`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Agent Result

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by. |
| `limit` | integer | No | Maximum number of records to return (max 1000). |
| `order` | string ("asc" | "desc") | No | Sort order: asc for ascending or desc for descending. |
| `offset` | integer | No | Number of records to skip before starting to return results. |
| `search` | string | No | Search term to filter results. |
| `agent_id` | string | Yes | Unique identifier of the agent to get results for. You can obtain agent IDs from the agents_get_all action. |
| `collection` | string | No | Collection name to filter results by. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all team members

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field by which to sort the results, e.g., 'name', 'email', or 'created_at'. |
| `limit` | integer | No | Maximum number of users to return. Maximum allowed is 1000. |
| `order` | string ("asc" | "desc") | No | Order of sorting: 'asc' (ascending) or 'desc' (descending). |
| `offset` | integer | No | Number of users to skip before starting to return results. Used for pagination. |
| `search` | string | No | Search term to filter users by name or email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get URL Redirects

**Slug:** `AGENTY_GET_BROWSER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Result

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by. |
| `limit` | integer | No | Maximum number of records to return (<=1000). |
| `order` | string ("asc" | "desc") | No | Sort order: asc for ascending or desc for descending. |
| `format` | string | No | Format for the result data. |
| `job_id` | integer | Yes | Unique identifier of the job to get result for. Get this from jobs_get_all or jobs_start actions. |
| `offset` | integer | No | Number of records to skip before starting to return results. |
| `search` | string | No | Search term to filter results. |
| `collection` | string | No | Collection name to filter results by. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | The unique identifier of the list to retrieve. Can be obtained from listing all lists or after creating a new list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List Row by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the row to fetch (MongoDB ObjectId format) |
| `list_id` | string | Yes | Unique identifier of the list containing the row |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Content

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the webpage to fetch HTML content from. Must be a valid HTTP or HTTPS URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Content with Options

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webpage URL to fetch HTML content from. Must be a valid HTTP or HTTPS URL. |
| `block_ads` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the project to retrieve. You can obtain project IDs from the projects_get_all action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Redirects with Options

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL to follow and get the complete redirect chain. Must be a valid HTTP or HTTPS URL. |
| `gotoOptions` | object | No | Browser navigation settings for page load behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Agent Schedule

**Slug:** `AGENTY_GET_SCHEDULE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Unique identifier of the agent whose schedule to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | The unique numeric identifier of the user to retrieve. This is the user's ID in the Agenty system. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | The unique identifier of the workflow to retrieve. This ID is returned when creating a workflow or can be obtained from listing workflows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get agent input by ID

**Slug:** `AGENTY_INPUTS_GET_BY_AGENT_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Unique identifier of the agent to retrieve inputs for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Input by Agent ID

**Slug:** `AGENTY_INPUTS_UPDATE_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download jobs

**Slug:** `AGENTY_JOBS_DOWNLOAD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by |
| `limit` | integer | No | Maximum number of jobs to return |
| `order` | string ("asc" | "desc") | No | Sort order: asc or desc |
| `offset` | integer | No | Number of jobs to skip before starting to collect the result set |
| `agent_id` | string | No | Filter jobs to only those created by this agent ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download job file by ID

**Slug:** `AGENTY_JOBS_DOWNLOAD_FILES_BY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 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. |
| `job_id` | integer | Yes | Unique identifier of the job to download files from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Job Result by ID

**Slug:** `AGENTY_JOBS_DOWNLOAD_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by |
| `limit` | integer | No | Maximum number of items to return |
| `order` | string ("asc" | "desc") | No | Sort order: asc or desc |
| `format` | string ("CSV" | "TSV" | "JSON") | Yes | Format of the downloaded file: CSV, TSV, or JSON |
| `job_id` | integer | Yes | Unique identifier of the job to download result for |
| `offset` | integer | No | Number of items to skip before starting to collect the result set |
| `collection` | integer | No | Result collection number to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch all jobs

**Slug:** `AGENTY_JOBS_GET_ALL`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field by which to sort the results, e.g., 'created_at' or 'status'. |
| `limit` | integer | No | Maximum number of records to return (<=1000). |
| `order` | string ("asc" | "desc") | No | Order of sorting; either 'asc' for ascending or 'desc' for descending. |
| `offset` | integer | No | Number of records to skip before starting to return results. |
| `agent_id` | string | No | Filter jobs by specific agent identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job by ID

**Slug:** `AGENTY_JOBS_GET_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | integer | Yes | The unique numeric identifier of the job to retrieve. Get this from jobs_get_all or jobs_start actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Logs by ID

**Slug:** `AGENTY_JOBS_GET_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of log lines to return (pagination limit). |
| `job_id` | string | Yes | Unique identifier of the job to fetch logs for. |
| `offset` | integer | No | Number of log lines to skip (pagination offset). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job output files

**Slug:** `AGENTY_JOBS_LIST_FILES_BY_ID`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | integer | Yes | Unique numeric identifier of the job whose output files you want to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Agent Job

**Slug:** `AGENTY_JOBS_START`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Unique identifier of the agent to start the job for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Job by ID

**Slug:** `AGENTY_JOBS_STOP_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | integer | Yes | Unique numeric identifier of the job to stop. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clear List Rows

**Slug:** `AGENTY_LISTS_CLEAR_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").

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Unique identifier of the list to clear rows from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `AGENTY_LISTS_CONTROLLER_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'."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the list, max 100 characters |
| `description` | string | No | Description of the list, max 250 characters |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List by ID

**Slug:** `AGENTY_LISTS_DELETE_BY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Unique identifier of the list to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download lists

**Slug:** `AGENTY_LISTS_DOWNLOAD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field name to sort by |
| `limit` | integer | No | Maximum number of items to return |
| `order` | string ("asc" | "desc") | No | Sort order: asc or desc |
| `offset` | integer | No | Number of items to skip before starting to collect the result set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all lists

**Slug:** `AGENTY_LISTS_GET_ALL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field by which to sort the results, e.g., 'name' or 'created_at'. |
| `limit` | integer | No | Maximum number of lists to return. |
| `order` | string ("asc" | "desc") | No | Order of sorting; possible values are 'asc' (ascending) and 'desc' (descending). |
| `offset` | integer | No | Number of lists to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch List Rows by ID

**Slug:** `AGENTY_LISTS_GET_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".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Column name to sort the results by |
| `limit` | integer | No | Number of rows to return per request |
| `order` | string ("asc" | "desc") | No | Sort order, either 'asc' or 'desc' |
| `offset` | integer | No | Number of rows to skip before starting to return rows |
| `list_id` | string | Yes | Unique identifier of the list to fetch rows from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List by ID

**Slug:** `AGENTY_LISTS_UPDATE_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'".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the list, max 100 characters. This field is required by the API. |
| `list_id` | integer | Yes | Unique identifier of the list to update |
| `description` | string | No | Description for the list, max 250 characters. This field is optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload CSV file to List

**Slug:** `AGENTY_LISTS_UPLOAD_CSV`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file to upload to the list. |
| `list_id` | integer | Yes | Unique identifier of the list to which the CSV will be uploaded. Must be a valid existing list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Workflow

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the workflow to update. This is the workflow ID obtained from listing workflows or when the workflow was created. |
| `name` | string | No | New name for the workflow. Use this to rename the workflow for better identification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Agents to Project

**Slug:** `AGENTY_PROJECTS_ADD_AGENTS`

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"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_ids` | array | Yes | List of agent IDs to add to the project (e.g., ['tx8lubfbun', 'o3xuc2n8es']). Must contain at least one agent ID. |
| `project_id` | integer | Yes | Unique identifier of the project to which agents will be added |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `AGENTY_PROJECTS_CONTROLLER_CREATE_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the project. Must be non-empty and maximum 64 characters. |
| `description` | string | No | Optional description of the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all projects

**Slug:** `AGENTY_PROJECTS_GET_ALL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field by which to sort the results, e.g., 'name' or 'created_at'. |
| `limit` | integer | No | Maximum number of projects to return. |
| `order` | string ("asc" | "desc") | No | Order of sorting; possible values are 'asc' (ascending) and 'desc' (descending). |
| `offset` | integer | No | Number of projects to skip before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Agent from Project

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Unique identifier of the agent to remove from the project |
| `project_id` | string | Yes | Unique identifier of the project from which the agent will be removed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Scrape Webpage Data

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webpage URL to scrape data from. Must be a valid HTTP or HTTPS URL. |
| `debug` | object | No | Debug options to include additional information in the response. |
| `query` | object | Yes | 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. |
| `blockAds` | boolean | No | Whether to block advertisements on the page. Default is true. |
| `userAgent` | string | No | Custom user agent string to use when making the request. If not provided, uses the browser's default user agent. |
| `gotoOptions` | object | No | Browser navigation settings for page load behavior. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Agent Schedule

**Slug:** `AGENTY_TOGGLE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | Set to true to enable the agent's schedule, or false to disable it. |
| `agent_id` | string | Yes | Unique identifier of the agent whose schedule should be toggled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Transfer Agent Ownership

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the target Agenty account to transfer the agent to. The email must be associated with an existing Agenty account. |
| `agent_id` | string | Yes | The unique identifier of the agent to transfer. You can obtain agent IDs from the agents_get_all action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List Row

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the row to update within the list |
| `list_id` | string | Yes | Unique identifier of the list containing the row to update |
| `row_data` | object | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the project to update. |
| `name` | string | Yes | Name of the project. Required field that must be non-empty and maximum 64 characters. |
| `description` | string | No | Description of the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Agent Schedule

**Slug:** `AGENTY_UPDATE_SCHEDULE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("cron" | "interval") | Yes | Schedule type: 'cron' for cron expression-based scheduling or 'interval' for frequency-based scheduling. |
| `agent_id` | string | Yes | Unique identifier of the agent whose schedule to update. |
| `frequency` | integer | No | Frequency value in seconds for interval-based scheduling (e.g., 3600 for hourly). Required when type is 'interval'. |
| `expression` | string | No | 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. |
| `is_enabled` | boolean | No | Enable or disable the schedule. When false, the schedule exists but will not trigger the agent. |
| `description` | string | No | Human-readable description of the schedule. This is typically auto-generated by Agenty based on the cron expression or frequency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User by ID

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | User's full name |
| `role` | string ("Owner" | "Admin" | "Manager") | Yes | User role. Valid options are: Owner (full access), Admin (administrative access), or Manager (management access). |
| `email` | string | Yes | User email address. Must be a valid email format. |
| `avatar` | string | No | URL of the user's avatar image |
| `status` | string ("active" | "inactive") | Yes | User status. Must be either 'active' or 'inactive'. |
| `user_id` | string | Yes | Unique identifier of the user to update |
| `is_email_verified` | boolean | No | Whether the user's email address has been verified |
| `is_email_subscribed` | boolean | No | Whether the user is subscribed to receive email notifications |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workflow

**Slug:** `AGENTY_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the workflow to update. |
| `name` | string | Yes | Updated name for the workflow (e.g., 'Send Email on Job Completion'). |
| `agents` | object | Yes | Configuration specifying which agents this workflow applies to. |
| `actions` | array | Yes | Array of actions to execute when the workflow is triggered. Must contain at least one action. |
| `trigger` | object | Yes | Trigger configuration defining when this workflow should execute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |