Configuration
Complete property reference for all 11 operations across 4 Apify node resources.
ApiToken is required on every operation. All operations require the
ApiToken property set to your Apify API token. This is not repeated in each table — assume it is always required.
ActorId format: Actor IDs follow the format
username/actor-name (e.g. apify/web-scraper, apify/cheerio-scraper). You can find the exact ID on any actor's page in the Apify Store URL or Console.
Resource: actor — 4 Operations
actor / run
Start an actor asynchronously. Returns immediately with a run object containing the run ID. Use actorRun/getRun to poll for status.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
ActorId | Required | Actor identifier in username/actor-name format (e.g. apify/web-scraper). |
InputJson | Optional | JSON string passed as the actor's input. Must match the actor's expected input schema. |
BuildTag | Optional | Actor build tag to run. Defaults to latest if omitted. |
TimeoutSeconds | Optional | Integer. Maximum run duration in seconds before the actor is forcibly stopped. No default (platform default applies). |
MemoryMb | Optional | Memory allocation for the run. See MemoryMb enum table below. |
actor / getLastRun
Retrieve the most recent run for the specified actor, optionally filtered to a particular run status.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
ActorId | Required | Actor identifier in username/actor-name format. |
Status | Optional | Filter by run status. Enum: SUCCEEDED, FAILED, RUNNING, ABORTED, TIMED-OUT, ABORTING. |
actor / runAndGetDatasetItems
Start an actor, wait synchronously for it to finish, and return all items from its default dataset. This is the recommended operation for most data extraction use cases.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
ActorId | Required | Actor identifier in username/actor-name format. |
InputJson | Optional | JSON string passed as the actor's input. |
BuildTag | Optional | Actor build tag. Defaults to latest. |
TimeoutSeconds | Optional | Maximum run duration in seconds before timeout. |
MemoryMb | Optional | Memory allocation. See MemoryMb enum table below. |
MaxItems | Optional | Integer. Maximum number of dataset items to return. Omit to return all items. |
DatasetId | Optional | Override the dataset to read from. Defaults to the run's default dataset if omitted. |
actor / scrapeSingleUrl
Convenience operation that scrapes a single URL using Apify's built-in URL scraper. No actor ID required.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
Url | Required | The URL to scrape. Must be a valid HTTP/HTTPS URL. |
WaitForSelectorCss | Optional | CSS selector to wait for before considering the page loaded (e.g. .product-price). |
ExtractHtml | Optional | Boolean. When true, include the full rendered HTML in the output. |
ExtractText | Optional | Boolean. When true, include the plain text content of the page. |
ScreenshotWidth | Optional | Integer. Viewport width in pixels for the screenshot. Common values: 1280, 1920. |
TakeScreenshot | Optional | Boolean. When true, capture a screenshot of the page and return it as base64. |
Resource: actorRun — 3 Operations
actorRun / getRun
Get the current status, timestamps, and statistics for a specific run by its run ID.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
RunId | Required | The run ID returned by actor/run or any run list operation. |
actorRun / getActorRuns
List all runs for a specific actor with optional status filtering and pagination.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
ActorId | Required | Actor identifier in username/actor-name format. |
Status | Optional | Filter by run status. Enum: SUCCEEDED, FAILED, RUNNING, ABORTED, TIMED-OUT, ABORTING. |
Limit | Optional | Integer. Number of runs to return per page. |
Offset | Optional | Integer. Number of runs to skip (for pagination). |
actorRun / getUserRunsList
List all runs across all actors for the account associated with the API token. Useful for monitoring platform-wide activity.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
Status | Optional | Filter by run status. Enum: SUCCEEDED, FAILED, RUNNING, ABORTED, TIMED-OUT, ABORTING. |
Limit | Optional | Integer. Number of runs to return per page. |
Offset | Optional | Integer. Number of runs to skip (for pagination). |
Resource: actorTask — 2 Operations
actorTask / run
Execute a saved actor task asynchronously. Returns immediately with the run ID.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
TaskId | Required | The task ID from Apify Console (found in the task URL). |
InputJson | Optional | JSON string to override the task's saved input for this run only. |
TimeoutSeconds | Optional | Integer. Maximum run duration in seconds. |
MemoryMb | Optional | Memory allocation for the run. See MemoryMb enum table below. |
actorTask / runAndGetDatasetItems
Run a task, wait for it to complete, and return all dataset items in one operation.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
TaskId | Required | The task ID from Apify Console. |
InputJson | Optional | JSON string to override the task's saved input for this run only. |
MaxItems | Optional | Integer. Maximum number of dataset items to return. |
Resource: dataset — 1 Operation
dataset / getItems
Read items from a specific Apify dataset by ID. Supports pagination, field selection, and clean mode to skip empty items.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
DatasetId | Required | The Apify dataset ID. Found in the Console or returned as defaultDatasetId in a run object. |
Clean | Optional | Boolean. When true, skip items where all fields are empty or null. |
Limit | Optional | Integer. Maximum number of items to return in a single request. |
Offset | Optional | Integer. Number of items to skip before returning results (for pagination). |
Fields | Optional | Comma-separated list of field names to include in the response (e.g. title,price,url). Omit to include all fields. |
Resource: keyValueStore — 1 Operation
keyValueStore / getRecord
Retrieve a single record from an Apify key-value store by its key name.
| Property | Required | Description |
|---|---|---|
ApiToken | Required | Apify API token. |
StoreId | Required | The key-value store ID. Actors write their default store as defaultKeyValueStoreId on the run object. |
RecordKey | Required | The key name of the record to retrieve (e.g. OUTPUT, SCREENSHOT). |
MemoryMb Enum Values
When specified, MemoryMb must be one of the following values. Higher memory enables more browser tabs and longer crawls but increases compute cost.
| Value (MB) | Suitable For |
|---|---|
128 | Lightweight data parsing, simple HTTP requests |
256 | Single-page scraping with moderate JavaScript |
512 | Standard headless browser actors |
1024 | Multi-page crawlers, Playwright-based actors |
2048 | Complex single-site crawls |
4096 | Large-scale website crawls |
8192 | Very large crawls or memory-intensive processing |
16384 | Enterprise-scale extractions |
32768 | Maximum — use only when required |
Run Status Enum Values
| Status | Meaning |
|---|---|
RUNNING | Actor is currently executing |
SUCCEEDED | Actor completed without errors |
FAILED | Actor exited with a non-zero exit code or unhandled exception |
ABORTED | Run was manually stopped or API-aborted |
TIMED-OUT | Run exceeded its configured timeout |
ABORTING | Abort requested — run is in the process of stopping |