New260+ blocks and 240+ tools are now fully documented
DocumentationReferenceTool IntegrationsWeb Scraping & Browsers
Tool

Apify

Run web scraping and browser automation actors on Apify

Apify lets you run web scraping and browser automation actors — pre-built or custom — directly from your workflows. Use it to extract structured data from websites, trigger long-running crawls, and retrieve the resulting datasets.

Overview

PropertyValue
Typeapify
CategoryTool — Web Scraping
AuthAPI Key (Authorization: Bearer)

Operations

OperationTool IDDescription
Run Actor (Sync)apify_run_actor_syncRun an actor and wait for it to finish (max 5 minutes), returning dataset items immediately
Run Actor (Async)apify_run_actor_asyncStart an actor asynchronously and poll until completion (up to 5 minutes), then fetch dataset items
Get Runapify_get_runFetch the status and metadata of an existing actor run by its run ID
Get Datasetapify_get_datasetFetch items from any Apify dataset by dataset ID, with optional pagination

Configuration

SettingTypeRequiredDescription
apiKeystring (secret)YesApify API token from console.apify.com/account#/integrations. Used as Authorization: Bearer header and token query param.
actorIdstringYes (sync/async run)Actor ID or slug in username/actor-name form. Examples: apify/web-scraper, janedoe/my-actor.
inputstringNoActor input as a JSON string. Example: {"startUrls": [{"url": "https://example.com"}]}. Parsed and sent as the POST body.
memorynumberNoMemory in megabytes allocated for the run (128–32768). Passed as ?memory= query param.
timeoutnumberNoTimeout in seconds for the actor run. Passed as ?timeout= query param.
buildstringNoActor build tag to use. Examples: latest, beta. Passed as ?build= query param.
waitForFinishnumberNo (async only)Initial wait in seconds (0–60) before polling begins.
itemLimitnumberNo (async only)Maximum dataset items to fetch after the run completes (1–250000, default 100).
runIdstringYes (Get Run / Get Dataset)The run ID to inspect or dataset ID to read from.
datasetIdstringYes (Get Dataset)The dataset ID to fetch items from.
limitnumberNo (Get Dataset)Maximum number of items to return (default 100).
offsetnumberNo (Get Dataset)Number of items to skip, for pagination.

Outputs

Run Actor (Sync) — apify_run_actor_sync

FieldTypeDescription
successbooleanWhether the actor run succeeded
runIdstringAlways sync-execution for sync runs
statusstringRun status: SUCCEEDED, FAILED, etc.
itemsarrayDataset items returned by the actor

Run Actor (Async) — apify_run_actor_async

FieldTypeDescription
successbooleanWhether the actor run succeeded
runIdstringApify run ID
statusstringTerminal status: SUCCEEDED, FAILED, ABORTED, TIMED-OUT, or TIMEOUT (poll exhausted)
datasetIdstringDefault dataset ID containing results
itemsarrayDataset items (populated only when status is SUCCEEDED)

Get Run — apify_get_run

FieldTypeDescription
idstringRun ID
actIdstringActor ID
statusstringCurrent run status
startedAtstringISO timestamp when the run started
finishedAtstringISO timestamp when the run finished (optional)
defaultDatasetIdstringDefault dataset ID for this run

Get Dataset — apify_get_dataset

FieldTypeDescription
itemsarrayDataset items
countnumberNumber of items returned in this response
totalnumberTotal number of items in the dataset
offsetnumberOffset used for this request
limitnumberLimit used for this request

Example

[Starter] → [Apify: Run Actor (Async)] → [Agent: summarize the results]

Trigger the apify/web-scraper actor with {{APIFY_API_KEY}} as the API token and a start URL supplied by an upstream block ({{starter.url}}). Pass {"startUrls": [{"url": "{{starter.url}}"}]} as the JSON input and set itemLimit to 50. Once the actor finishes polling, the items output flows into an Agent block that summarizes the scraped content, referencing it as {{apify.items}}.

Tips

  • Sync vs Async — Use Run Actor (Sync) for quick actors that finish in under 5 minutes. For heavy crawls or scrapes that may run longer, use Run Actor (Async), which polls every 5 seconds for up to 5 minutes.
  • API token — Get your token from console.apify.com/account#/integrations. Store it as an environment variable and reference it as {{APIFY_API_KEY}} rather than pasting it directly into the block.
  • Actor ID format — Always use the username/actor-name slug (e.g. apify/web-scraper) or the actor's unique ID. Misformatted IDs will return a 404 from the Apify API.
  • Paginating large datasets — If an actor produces more items than your itemLimit, use Get Dataset with offset and limit to page through results using the datasetId from a completed run.