Sim

Apify

Run Apify actors and retrieve results

Apify is a powerful platform for building, deploying, and running web automation and web scraping actors at scale. Apify enables you to extract useful data from any website, automate workflows, and connect your data pipelines seamlessly.

With Apify, you can:

  • Run ready-made or custom actors: Integrate public actors or develop your own, automating a wide range of web data extraction and browser tasks.
  • Retrieve datasets: Access and manage structured datasets collected by actors in real time.
  • Scale web automation: Leverage cloud infrastructure to run tasks reliably, asynchronously or synchronously, with robust error handling.

In Sim, the Apify integration allows your agents to perform core Apify operations programmatically:

  • Run Actor (Sync): Use apify_run_actor_sync to launch an Apify actor and wait for its completion, retrieving the results as soon as the run finishes.
  • Run Actor (Async): Use apify_run_actor_async to start an actor in the background and periodically poll for results, suitable for longer or complex jobs.

These operations equip your agents to automate, scrape, and orchestrate data collection or browser automation tasks directly inside workflows — all with flexible configuration and result handling, without the need for manual runs or external tools. Integrate Apify as a dynamic automation and data-extraction engine that programmatically powers your agents' web-scale workflows.

Usage Instructions

Integrate Apify into your workflow. Run any Apify actor with custom input and retrieve results. Supports both synchronous and asynchronous execution with automatic dataset fetching.

Tools

apify_run_actor_sync

Run an APIFY actor synchronously and get results (max 5 minutes)

Input

ParameterTypeRequiredDescription
apiKeystringYesAPIFY API token from console.apify.com/account#/integrations
actorIdstringYesActor ID or username/actor-name (e.g., "janedoe/my-actor" or actor ID)
inputstringNoActor input as JSON string. See actor documentation for required fields.
timeoutnumberNoTimeout in seconds (default: actor default)
buildstringNoActor build to run (e.g., "latest", "beta", or build tag/number)

Output

ParameterTypeDescription
successbooleanWhether the actor run succeeded
runIdstringAPIFY run ID
statusstringRun status (SUCCEEDED, FAILED, etc.)
datasetIdstringDataset ID containing results
itemsarrayDataset items (if completed)

apify_run_actor_async

Run an APIFY actor asynchronously with polling for long-running tasks

Input

ParameterTypeRequiredDescription
apiKeystringYesAPIFY API token from console.apify.com/account#/integrations
actorIdstringYesActor ID or username/actor-name (e.g., "janedoe/my-actor" or actor ID)
inputstringNoActor input as JSON string
waitForFinishnumberNoInitial wait time in seconds (0-60) before polling starts
itemLimitnumberNoMax dataset items to fetch (1-250000, default 100)
timeoutnumberNoTimeout in seconds (default: actor default)
buildstringNoActor build to run (e.g., "latest", "beta", or build tag/number)

Output

ParameterTypeDescription
successbooleanWhether the actor run succeeded
runIdstringAPIFY run ID
statusstringRun status (SUCCEEDED, FAILED, etc.)
datasetIdstringDataset ID containing results
itemsarrayDataset items (if completed)

Notes

  • Category: tools
  • Type: apify
On this page

On this page

Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started