Apify

Overview

Apify is a platform for building, deploying, and managing web scraping and automation tools known as Actors. With the Apify integration in SquadOS, your agents can run any public Actor from the Apify Store, store and retrieve data from datasets and key-value stores, manage scheduled tasks, and automate complete data collection and processing workflows on the web.

• Official website: https://apify.com/
• Composio documentation: docs.composio.dev/toolkits/apify

Authentication

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	API token from your Apify account, used to authenticate all requests.

How to get credentials

1. Go to apify.com and log in (or create a free account).
2. Click your avatar in the top-right corner and go to Settings.
3. In the sidebar, select Integrations (or API & Integrations).
4. Find the Personal API tokens section and click + Create new token.
5. Give the token a name (e.g., squados) and copy the generated value.

Tip

Use a dedicated token for SquadOS. This lets you revoke access without affecting other integrations, and you can restrict permissions if the platform offers granular scopes.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Apify.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Note

This integration exposes 113 actions in total. The most relevant ones are listed below; see the full list in the Composio documentation.

Run Actor Asynchronously

APIFY_RUN_ACTOR

Tool to run a specific Actor asynchronously. Use when you need to trigger an Actor run without waiting for completion and retrieve its run details immediately.

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID or <username>~<actorName> (tilde) or <username>/<actorName> (forward slash), e.g., apify~hello-world.
body	object	No	JSON input object passed to the Actor. Each Actor has its own input schema — check the documentation on Apify Store.
build	string	No	Tag or build number of the Actor build to run.
memory	number	No	Memory limit for the run in megabytes. Must be power of 2, minimum 128.
timeout	number	No	Timeout for the run in seconds.
maxItems	number	No	Maximum number of items that the Actor run should return.
waitForFinish	number	No	Max seconds the server waits for the run to finish. Default: 0, max: 60.
maxTotalChargeUsd	number	No	Specifies the maximum cost of the Actor run in USD.

Output

Name	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

Run Actor Sync

APIFY_RUN_ACTOR_SYNC

Tool to run a specific Actor synchronously with input and return its output record. Use when immediate Actor results are needed; runs may timeout after 300 seconds. To avoid timeouts, scope inputs to specific URLs rather than broad crawls and request only necessary fields.

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID or a tilde-separated owner and actor name (e.g., user~actor-name).
input	object	Yes	JSON object passed as input to the Actor run.
build	string	No	Build tag or number to run (default Actor’s default build, usually latest).
memory	integer	No	Memory limit in MB; power of two, minimum 128.
timeout	number	No	Run timeout in seconds. HTTP wait max 300s.
maxItems	integer	No	Maximum number of dataset items to return.
outputRecordKey	string	No	Key of the record in the default key-value store to return (default OUTPUT).
maxTotalChargeUsd	number	No	Maximum total charge in USD for the run. For pay-per-result actors, required and minimum $1.00.

Output

Name	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

Run Actor Sync & Get Dataset Items

APIFY_RUN_ACTOR_SYNC_GET_DATASET_ITEMS

Tool to run an Actor synchronously and retrieve its dataset items. Use when immediate access to run results is needed.

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID or name in format username/actor-name or username~actor-name. The actor must exist on Apify Store.
input	object	No	JSON input object passed to the Actor run. Check the exact input schema for the Actor before calling.
build	string	No	Tag or number of the Actor build to run (e.g., beta or 1.2.345).
memory	integer	No	Memory limit for the Actor run in megabytes.
timeout	integer	No	Timeout for the Actor run in seconds. Zero means no timeout.
format	string	No	Response format. Default: json.
limit	integer	No	Maximum number of items to return.
offset	integer	No	Number of items to skip from the start.
maxItems	integer	No	Maximum number of dataset items charged for pay-per-result Actors.
waitForFinish	integer	No	Maximum time in seconds the server waits for the run to finish (0-300).

Output

Name	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 Actor Last Run Dataset Items

APIFY_GET_ACTOR_LAST_RUN_DATASET_ITEMS

Tool to get dataset items from the last run of an Actor. Use when you need to retrieve output data from the most recent Actor execution, optionally filtered by run status (e.g., status='SUCCEEDED').

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID or tilde-separated owner’s username and Actor name (e.g., janedoe~my-actor).
status	string	No	Filter to return dataset items only from runs with a specific status (READY, RUNNING, SUCCEEDED, FAILED, TIMED-OUT, ABORTED).
format	string	No	Output format for the dataset items. Default is JSON.
limit	integer	No	Maximum number of items to return. API has a limit of 250,000 items per request.
offset	integer	No	Number of items to skip from the start (pagination). Default is 0.
clean	boolean	No	Shortcut for skipHidden=true and skipEmpty=true. Removes Apify-specific metadata and empty items.

Output

Name	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 Run Dataset Items

APIFY_GET_RUN_DATASET_ITEMS

Tool to get dataset items from a specific Actor run. Use when you need to retrieve the output data from a completed or running Actor run.

Input parameters

Name	Type	Required	Description
runId	string	Yes	The unique identifier of the Actor run to retrieve dataset items from.
format	string	No	Output format for the dataset items. Default is JSON.
limit	integer	No	Maximum number of items to return.
offset	integer	No	Number of items to skip from the start (pagination). Default is 0.
clean	boolean	No	When true, removes any Apify-specific metadata from items.
desc	boolean	No	If true, returns items in reverse order (newest to oldest).

Output

Name	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 Dataset Items

APIFY_GET_DATASET_ITEMS

Tool to retrieve items from a dataset. Use when you need to fetch data from a specified dataset by pagination or filtering. Only JSON format is fully supported. For datasets larger than 1000 items, issue multiple calls incrementing offset by limit until the response returns fewer items than limit.

Input parameters

Name	Type	Required	Description
datasetId	string	Yes	Identifier of the dataset to retrieve items from (e.g., username/datasetName or dataset ID).
format	string	No	Output format of dataset items. Only json is fully supported.
limit	integer	No	Maximum number of items to return (pagination). Default and max is 1000.
offset	integer	No	Number of items to skip (pagination). Default is 0.
clean	boolean	No	When true, removes any Apify-specific metadata from items.
desc	boolean	No	If true, return items in reverse order.
fields	string	No	Comma-separated list of fields to include in the returned items.
omit	string	No	Comma-separated list of fields to exclude from the returned items.

Output

Name	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

Store Data in Dataset

APIFY_STORE_DATA_IN_DATASET

Tool to store data items in a dataset. Use after collecting data when you want to batch-append or update items in an existing dataset.

Input parameters

Name	Type	Required	Description
datasetId	string	Yes	Dataset ID or name (e.g., username/datasetName or dataset ID).
data	array	Yes	Array of JSON-serializable objects to store in the dataset.
omit	string	No	Comma-separated list of fields to exclude when storing items.
fields	string	No	Comma-separated list of fields to include when storing items.
deduplicate	boolean	No	If true, deduplicate incoming items by their foreignId.

Output

Name	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 Dataset

APIFY_CREATE_DATASET

Tool to create a new dataset. Use when you need to initialize or retrieve a dataset by name.

Input parameters

Name	Type	Required	Description
name	string	No	Custom unique name for the dataset (1-63 characters). Must contain only lowercase letters (a-z), digits (0-9), and hyphens (-). Hyphens can only appear in the middle. If omitted, a random name is generated.

Output

Name	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 Key-Value Record

APIFY_GET_KEY_VALUE_RECORD

Tool to retrieve a record from a key-value store. Use when you need to fetch a specific value by key from an Apify Key-Value Store.

Input parameters

Name	Type	Required	Description
storeId	string	Yes	ID of the key-value store.
recordKey	string	Yes	Key of the record to retrieve.
format	string	No	Desired format of the retrieved record (json, xml, html, text).
disableRedirect	boolean	No	If true, do not redirect to the raw value; return metadata only.

Output

Name	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

Store Data in Key-Value Store

APIFY_STORE_DATA_IN_KEY_VALUE_STORE

Tool to create or update a record in a key-value store. Use after you have the store ID and record key to persist JSON data.

Input parameters

Name	Type	Required	Description
storeId	string	Yes	ID of the key-value store where the record will be stored.
recordKey	string	Yes	Key under which the record will be stored or updated.
recordValue	object	Yes	The JSON object to store. Must be JSON-serializable.

Output

Name	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 Key-Value Store Keys

APIFY_KEY_VALUE_STORE_KEYS_GET

Tool to retrieve a list of keys from a key-value store. Use when you need to list keys in a store with optional filtering and pagination support.

Input parameters

Name	Type	Required	Description
storeId	string	Yes	Key-value store ID or username~store-name.
limit	integer	No	Number of keys to return. Maximum value is 1000.
prefix	string	No	Limits results to keys starting with the specified prefix.
exclusiveStartKey	string	No	All keys up to this one (including) are skipped from the result. Used for pagination.

Output

Name	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 Actor Details

APIFY_GET_ACTOR

Tool to get details of a specific Actor. Use when you need actor metadata by ID or username/actorName. Response includes isDeprecated and notice fields indicating deprecation status, and pricingInfos for per-unit cost details — review both before scheduling runs.

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID as either username and actor name separated by tilde (~) or forward slash (/), e.g., apify~web-scraper or apify/web-scraper, or 24-character hexadecimal ID.

Output

Name	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 of Actors

APIFY_ACTS_GET

Tool to get the list of all Actors that the user created or used. Use when you need to enumerate or browse Actors. Add my=1 to get only user-created Actors.

Input parameters

Name	Type	Required	Description
my	boolean	No	If true or 1, returns only Actors owned by the user. Default is false.
desc	boolean	No	If true or 1, sorts objects by createdAt field in descending order. Default is false (ascending).
limit	integer	No	Maximum number of records to return (pagination). Default and max is 1000.
offset	integer	No	Number of records to skip at the start (pagination). Default is 0.

Output

Name	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 of Actors in Store

APIFY_STORE_GET

Tool to get list of public Actors from Apify Store. Use when you need to browse or search public Actors available in the store. Supports searching by title, name, description, username, and readme.

Input parameters

Name	Type	Required	Description
search	string	No	Search string to filter Actors by title, name, description, username, and readme. Example: web scraper.
limit	integer	No	Maximum number of Actors to return (pagination). Default is 10, maximum is 1000.
offset	integer	No	Number of Actors to skip at the start (pagination). Default is 0.

Output

Name	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 Actor

APIFY_CREATE_ACTOR

Tool to create a new Actor with specified configuration. Use when you need to initialize a fresh Actor programmatically before publishing or running it.

Input parameters

Name	Type	Required	Description
name	string	Yes	Unique name for the new actor (must be 1-63 characters, lowercase letters, digits, and dashes).
title	string	No	Human-readable title for the actor.
description	string	No	Detailed description of what the actor does.
isPublic	boolean	No	Whether the actor should be publicly visible on Apify Store. Cannot be true on actor creation — actors must be created as private, then built and published later.
versions	array	No	Initial actor versions definition.
categories	array	No	List of category IDs to which this actor belongs.
defaultRunOptions	object	No	Default execution options for running the Actor.

Output

Name	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

Build Actor

APIFY_ACT_BUILDS_POST

Tool to build an Actor with specified configuration. Use when you need to create a new build of an Actor with a specific version. The build process compiles the Actor’s source code into a Docker image.

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID or a tilde-separated owner’s username and Actor name (e.g., janedoe~my-actor).
tag	string	No	Optional version tag specification for the build.
versionNumber	string	No	Actor version to build (e.g., 0.1). If not provided, the latest version is used.
useCache	boolean	No	If true, uses cached layers from previous builds. Default: true.
waitForFinish	integer	No	Optional timeout value (in seconds) to wait for build completion before returning response. Max 300 seconds.

Output

Name	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 Actor Run

APIFY_ACTOR_RUN_GET

Tool to get details about a specific Actor run including its execution status, resource usage, storage IDs, and metadata.

Input parameters

Name	Type	Required	Description
runId	string	Yes	The unique identifier of the Actor run to retrieve.
waitForFinish	integer	No	Maximum seconds to wait for run completion before returning response. Range: 0-60.

Output

Name	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

Abort Actor Run

APIFY_ACTOR_RUN_ABORT_POST

Tool to abort a running or starting Actor run. For runs with status FINISHED, FAILED, ABORTING, and TIMED-OUT this call does nothing.

Input parameters

Name	Type	Required	Description
runId	string	Yes	The unique identifier of the Actor run to abort.
gracefulAbort	boolean	No	If true, the Actor run will abort gracefully. It will send aborting and persistStates events into the run and force-stop the run after 30 seconds. This is helpful when you plan to resurrect the run later. Default: false.

Output

Name	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 of runs

APIFY_GET_LIST_OF_RUNS

Tool to get a list of runs for a specific Actor. Use when you need to paginate through runs and optionally filter by status before processing run data.

Input parameters

Name	Type	Required	Description
actorId	string	Yes	Actor ID (e.g., HG7ML7M8z78YcAPEB) or a tilde-separated owner username and Actor name (e.g., janedoe~my-actor).
status	string	No	Filter runs by this lifecycle status (READY, RUNNING, SUCCEEDED, FAILED, TIMED-OUT, ABORTED).
desc	boolean	No	If true, sort by startedAt descending. Default is ascending.
limit	integer	No	Maximum number of runs to return (pagination). Default and max is 1000.
offset	integer	No	Number of runs to skip at the start (pagination). Default is 0.

Output

Name	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 Actor Task

APIFY_CREATE_TASK

Tool to create a new Actor task with specified settings. Use when you need to configure or schedule recurring Actor runs programmatically.

Input parameters

Name	Type	Required	Description
name	string	Yes	Name of the task. Must contain only lowercase letters (a-z), digits (0-9), and hyphens (only in the middle).
actId	string	Yes	ID or username~actorName of the Actor to attach the task to.
input	object	No	Input configuration for the task. Keys must exactly match the target Actor’s input schema.
title	string	No	Display title for the task.
options	object	No	Task execution options such as memoryMbytes, timeoutSecs, build.

Output

Name	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

Run Task Asynchronously

APIFY_RUN_TASK

Tool to run a specific Actor task asynchronously. Use when you need to trigger a task run without waiting for completion and immediately retrieve its run details.

Input parameters

Name	Type	Required	Description
actorTaskId	string	Yes	Task ID (e.g., HG7ML7M8z78YcAPEB) or tilde-separated owner username and task name (e.g., janedoe~my-task). Note: Use tilde (~) as separator, not slash (/).
body	object	No	JSON input object passed to the Actor.
build	string	No	Specifies the Actor build to run (tag or build number).
memory	number	No	Memory limit for the run, in megabytes. Must be power of 2 and at least 128.
timeout	number	No	Optional timeout for the run, in seconds.
waitForFinish	number	No	Max seconds the server waits for the run to finish. Default 0, max 60.

Output

Name	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 Schedule

APIFY_SCHEDULES_POST

Tool to create a new schedule with specified settings. Use when you need to automate Actor or Actor task execution at specific times using cron expressions.

Input parameters

Name	Type	Required	Description
isEnabled	boolean	Yes	True if the schedule should be enabled.
isExclusive	boolean	Yes	When set to true, don’t start Actor or Actor task if it’s still running from the previous schedule.
cronExpression	string	Yes	The cron expression used by this schedule (e.g., @monthly, @daily, 0 0 * * *).
name	string	No	The schedule’s name (should be 3-63 characters long).
title	string	No	A human-friendly display title for the schedule.
actions	array	No	Actors or tasks that should be run on this schedule.
timezone	string	No	Timezone in which your cron expression runs (TZ database name format, e.g., UTC, America/New_York). Defaults to UTC.

Output

Name	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 Current User Account Data

APIFY_USERS_ME_GET

Tool to get private user account information including profile, subscription plan, and proxy settings. Note: plan, email, and profile fields are omitted when accessed from Actor run.

Output

Name	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 Account Limits

APIFY_USERS_ME_LIMITS_GET

Tool to get a complete summary of account limits and usage. Use when you need to retrieve information about usage cycles, spending caps, compute resources, data transfer quotas, and other account limits. This shows the same information as the Limits page in Apify console.

Output

Name	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 Monthly Usage

APIFY_USERS_ME_USAGE_MONTHLY_GET

Tool to get the monthly usage of the account. Use when you need to check consumption statistics for the current period.

Output

Name	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