Apify
Run Apify Actors and retrieve a bounded slice of their dataset results.
Connectors
Choose the connector that matches your authentication method. The options below use the names shown in StackAI.
Apify
API Token
Apify
Connect to Apify to run Actors and read their dataset results.
Set up in Apify
Prepare the Apify account or service that the workflow will access. Grant access to the required resources and operations.
API Token: An Apify API token from Apify Console.
Set up in StackAI
Open Settings → Connections, add a connection, and select Apify.
Enter the credentials and connection details in the fields below.
Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.
Connection fields
Verify the connection
Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.
If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.
Use an action
Add the required Apify action to the workflow.
Select a connection when the action requests one.
Complete the required fields. Use the reference picker when a value comes from another workflow step.
Run the workflow and inspect the action’s output. Check the result before using it in a later step.
Actions
List Actors
List Actors created or recently used by the connected Apify account.
Inputs
Owned actors only
boolean
No
Only include Actors owned by the connected account. Default: false.
Sort by
select (string)
Yes
Choose whether to sort by creation time or most recent run time. Available values: Creation time, Most recent run. Default: stats.lastRunStartedAt.
Newest first
boolean
No
Return the newest or most recently run Actors first. Default: true.
Starting offset
integer
No
Skip this many Actors before collecting results. Minimum: 0. Default: 0.
Maximum actors
integer
No
Maximum number of Actor summaries to return. Minimum: 1. Maximum: 1000. Default: 100.
Outputs
Actors
object_array
Compact Actor summaries with IDs, names, titles, owners, and timestamps.
Total actors
integer
Total matching Actors reported by Apify.
Next offset
integer
Offset for the next page, or empty when there are no more Actors.
Run Actor
Start an Apify Actor asynchronously with a JSON input and optional runtime controls.
Inputs
Actor
select (string)
Yes
Actor ID or username~actor-name identifier to run. Options load from the selected connection.
Actor input
textarea
Yes
JSON object passed to the Actor as its input. Default: {}.
Run timeout in seconds
integer
No
Override the Actor's configured run timeout.
Memory in MB
integer
No
Override memory when the Actor documentation recommends it.
Maximum charged dataset items
integer
No
Cap charged dataset items for pay-per-result Actors.
Maximum total charge in USD
number
No
Cap the total charge for this run across pricing models.
Restart on error
boolean
No
Ask Apify to restart the run if it fails. Default: false.
Actor build
string
No
Specific build tag or build number to run.
Wait for finish
integer
No
Wait briefly for the run to finish before returning its latest status. Default: 0.
Outputs
Run ID
string
ID of the started Actor run.
Actor ID
string
ID of the Actor that owns the run.
Run status
select
Current lifecycle status of the Actor run.
Started at
datetime
Timezone-aware run start time.
Finished at
datetime
Timezone-aware finish time when the run has ended.
Default dataset ID
string
ID of the run's default output dataset.
Status message
string
Provider status message for the run, when available.
Usage total in USD
number
Preliminary or finalized total usage charge reported for the run.
Get Actor Run
Get the status and compact details of one Apify Actor run.
Inputs
Run ID
string
Yes
ID of the Actor run to inspect.
Wait for finish
integer
No
Wait briefly for the run to finish before returning its status. Default: 0.
Outputs
Run ID
string
ID of the Actor run.
Actor ID
string
ID of the Actor that owns the run.
Run status
select
Current lifecycle status of the Actor run.
Started at
datetime
Timezone-aware time when the run started.
Default dataset ID
string
ID of the run's default output dataset.
Finished at
datetime
Timezone-aware finish time when the run has ended.
Status message
string
Provider status message when available.
Usage total in USD
number
Preliminary or finalized total usage charge reported for the run.
Get dataset items
Read a small, resumable JSON slice from an Apify dataset.
Inputs
Dataset ID
string
Yes
Dataset ID or exact username~dataset-name identifier to read.
Starting offset
integer
No
Skip this many stored source items before reading results. Default: 0.
Maximum items
integer
No
Maximum number of dataset items to return in this call. Default: 25.
Fields to keep
string
No
Comma-separated fields to keep in each item.
Fields to omit
string
No
Comma-separated fields to remove from each item.
Newest items first
boolean
No
Reverse the stored item order. Default: false.
Skip hidden fields
boolean
No
Omit fields whose names begin with #. Default: true.
Outputs
Dataset items
object_array
Selected JSON dataset objects, bounded by item and byte limits.
Item count
integer
Number of items returned in this call.
Next offset
integer
Offset for the next ascending slice, or empty when continuation is unsafe.
Abort Actor Run
Stop one running Apify Actor run.
Inputs
Run ID
string
Yes
ID of the Actor run to stop.
Stop gracefully
boolean
No
Send persistence events before Apify force-stops the Actor after 30 seconds. Default: false.
Outputs
Run ID
string
ID of the Actor run.
Run status
select
Current lifecycle status of the Actor run.
Finished at
datetime
Time when the run finished, when available.
Status message
string
Provider status message when available.
Important behavior
Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.
The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.
Last updated
Was this helpful?