Tools

Run Actor

Start an Actor run on Apify, either asynchronously (returns immediately with run details) or synchronously (waits for completion and returns dataset items). Use this to execute web scrapers, automation tools, or any Actor from the Apify Store or your own custom Actors.

Manage Task

Create, get, update, delete, list, or run Actor Tasks. Tasks are reusable saved configurations for running Actors with pre-defined input and options.

Manage Actor

Get, create, update, or delete an Actor. Use this to manage Actor configurations including name, description, versions, memory settings, and build options.

List Runs

List runs for a specific Actor. Returns run metadata including status, timing, and storage IDs. Useful for monitoring Actor execution history and finding completed runs.

Abort Run

Abort a running Actor execution. Transitions the run to ABORTING and then ABORTED status. Use this to stop long-running or stuck Actors.

Manage Webhook

Create, get, update, delete, or list webhooks. Webhooks fire HTTP POST requests to a URL when Actor run or build events occur. Supports payload templates with variable interpolation.

Get Dataset Items

Retrieve items from an Apify dataset. Datasets store structured tabular data produced by Actor runs. You can filter by fields, paginate, and clean the results. Use the dataset ID from an Actor run's output or from listing datasets.

Manage Schedule

Create, get, update, delete, or list schedules. Schedules automatically start Actors or Tasks at specified times using cron expressions. Each schedule supports up to 10 Actors and 10 Tasks.

Manage Key Value Store

Interact with Apify Key-Value Stores: list stores, list keys, get a record, set a record, or delete a record. Key-value stores hold arbitrary data (JSON, HTML, images, etc.) identified by string keys.

Get Run

Retrieve details and optionally dataset items or logs for a specific Actor run. Use this to check the status of a running or completed Actor, fetch its results, or view execution logs.

Push Dataset Items

Append items to an Apify dataset. Datasets are append-only structured storage. Use this to add scraped data, processed results, or any structured records to a dataset.

Build Actor

Trigger a build for an Actor or retrieve build details. Builds compile Actor source code into runnable Docker images. You can specify version and tag, and list previous builds.

List Actors

List Actors in your Apify account. Returns Actor metadata including IDs, names, descriptions, and run statistics. Use this to discover available Actors, find Actor IDs for running, or review your Actor inventory.