Reference

Abort Actor Build

Tool to abort an Actor build that is starting or running.

Abort Actor Run

Tool to abort a running or starting Actor run.

Add Request to Queue

Adds a web page URL to a crawling queue, enabling systematic data extraction from websites without accidentally duplicating work. Useful for managing multiple URLs to scrape in a controlled, batch-oriented way.

Batch Add Requests to Queue

Tool to batch-add up to 25 requests to a request queue.

Batch Delete Requests from Queue

Tool to batch-delete up to 25 requests from a queue.

Build Actor

Compiles an Actor's source code into a deployable Docker image, allowing you to create a new version of your automation or scraping tool with specific configuration.

Check Key-Value Store Record Exists

Tool to check if a record exists in a key-value store.

Create Actor

Tool to create a new Actor with specified configuration.

Create Actor Task

Tool to create a new Actor task with specified settings.

Create Actor Version

Tool to create a new version of an Actor.

Create Actor Version Environment Variable

Tool to create an environment variable for a specific Actor version.

Create Dataset

Tool to create a new dataset.

Create Key-Value Store

Tool to create a new key-value store or retrieve an existing one by name.

Create Request Queue

Tool to create a new request queue or retrieve an existing one by name.

Create Schedule

Tool to create a new schedule with specified settings.

Create Task Webhook

Creates a webhook to automatically notify external systems when a specific Apify task completes, fails, or reaches other run events, enabling real-time integrations.

Delete Actor

Tool to delete an Actor permanently.

Delete Actor Build

Tool to delete an Actor build permanently.

Delete Actor Run

Tool to delete a finished Actor run.

Delete Actor Task

Tool to delete an Actor task permanently.

Delete Actor Version

Removes a specific version of an Actor's source code to keep your project organized and free of outdated or erroneous versions.

Delete Actor Version Environment Variable

Tool to delete an environment variable from a specific Actor version.

Delete Dataset

Tool to delete a dataset permanently.

Delete Key-Value Store

Tool to delete a key-value store permanently.

Delete Key-Value Store Record

Tool to delete a record from a key-value store.

Delete Request from Queue

Tool to delete a specific request from a request queue.

Delete Request Lock

Tool to delete a request lock from a request queue.

Delete Request Queue

Tool to delete a request queue permanently.

Delete Schedule

Tool to delete a schedule by its ID.

Delete Webhook

Tool to delete a webhook by its ID.

Get Account Limits

Tool to get a complete summary of account limits and usage.

Get Actor Build

Tool to get detailed information about a specific Actor build.

Get Actor Build Log

Tool to retrieve the log file for a specific Actor build.

Get Actor Details

Tool to get details of a specific Actor.

Get Actor Last Run Dataset Items

Tool to get dataset items from the last run of an Actor.

Get Actor Run

Tool to get details about a specific Actor run.

Get Actor Task

Tool to get complete details about an Actor task.

Get Actor version

Tool to get details about a specific version of an Actor.

Get Actor Version Environment Variable

Tool to get environment variable details for a specific Actor version.

Get all webhooks

Tool to get a list of all webhooks created by the user.

Get Current User Account Data

Tool to get private user account information.

Get Dataset

Tool to retrieve dataset metadata by dataset ID.

Get dataset items

Tool to retrieve items from a dataset.

Get Dataset Statistics

Tool to get dataset field statistics by dataset ID.

Get Default Build

Tool to get the default build for an Actor.

Get Head and Lock Queue Requests

Tool to get and lock head requests from the queue.

Get Key-Value Record

Tool to retrieve a record from a key-value store.

Get Key-Value Store

Tool to retrieve key-value store metadata by store ID.

Get Key-Value Store Keys

Tool to retrieve a list of keys from a key-value store.

Get last actor run

Tool to get the most recent run of a specific Actor.

Get last actor task run

Tool to get the most recent run of a specific Actor task.

Get list of Actor version environment variables

Tool to get the list of environment variables for a specific Actor version.

Get list of Actor versions

Tool to get the list of versions of a specific Actor.

Get list of Actor webhooks

Tool to get a list of webhooks for a specific Actor.

Get list of Actors

Retrieves a list of all Apify Actors you've created or used, making it easy to browse, find, and manage your automation tools for tasks like web scraping and data processing.

Get list of Actors in Store

Tool to get list of public Actors from Apify Store.

Get list of builds

Tool to get a list of builds for a specific Actor.

Get list of datasets

Tool to get list of datasets for a user.

Get list of key-value stores

Tool to get the list of key-value stores owned by the user.

Get list of request queues

Tool to get list of request queues for a user.

Get list of runs

Tool to get a list of runs for a specific Actor.

Get list of schedules

Tool to get list of schedules created by the user.

Get list of task runs

Tool to get a list of runs for a specific Actor task.

Get list of task webhooks

Tool to get a list of webhooks for a specific Actor task.

Get list of tasks

Tool to fetch a paginated list of tasks belonging to the authenticated user.

Get list of webhook dispatches

Tool to get list of webhook dispatches for the user.

Get log

Tool to retrieve logs for a specific Actor run or build.

Get Monthly Usage

Tool to get monthly usage summary with daily breakdown.

Get OpenAPI Definition

Tool to get the OpenAPI definition for a specific Actor build.

Get Public User Data

Retrieve publicly available information about an Apify user account, enabling you to research and evaluate users without requiring authentication.

Get Request from Queue

Retrieves detailed information about a specific request in an Apify request queue by its ID, allowing you to inspect its status, payload, or metadata for monitoring and debugging.

Get Request Queue

Tool to retrieve request queue metadata by queue ID.

Get Request Queue Head

Tool to retrieve first requests from the queue for inspection.

Get Run Dataset Items

Tool to get dataset items from a specific Actor run.

Get Schedule

Tool to get schedule details by ID.

Get Schedule Log

Tool to get schedule log by ID.

Get Task Input

Tool to retrieve the input configuration of a specific task.

Get Task Last Run Dataset Items

Tool to get dataset items from the last run of an Actor task.

Get user builds list

Tool to get a paginated list of all builds for a user.

Get webhook

Tool to get webhook object with all details.

Get Webhook Dispatch

Tool to get webhook dispatch object with all details.

Get webhook dispatches

Tool to get list of webhook dispatches for a specific webhook.

List Request Queue Requests

Tool to list requests in a request queue with pagination support.

List User Actor Runs

Tool to get a paginated list of all Actor runs for the authenticated user.

Prolong Request Lock

Tool to prolong request lock in a request queue.

Resurrect Run

Tool to resurrect a finished Actor run.

Run Actor Asynchronously

Tool to run a specific Actor asynchronously.

Run Actor Sync

Tool to run a specific Actor synchronously with input and return its output record.

Run Actor Sync & Get Dataset Items

Tool to run an Actor synchronously and retrieve its dataset items.

Run Actor Sync & Get Dataset Items

Tool to run Actor synchronously and get dataset items.

Run Actor Sync without Input (GET)

Tool to run a specific Actor synchronously without input and return its output.

Run Task Asynchronously

Tool to run a specific Actor task asynchronously.

Run Task Sync (GET)

Tool to run a specific task synchronously and return its output.

Run Task Sync (POST)

Tool to run an Actor task synchronously with input override and return its output.

Run Task Sync & Get Dataset Items

Tool to run an actor task synchronously and retrieve its dataset items.

Run Task Sync with Input Override & Get Dataset Items

Tool to run an actor task synchronously with input overrides and retrieve its dataset items.

Store Data in Dataset

Tool to store data items in a dataset.

Store Data in Key-Value Store

Tool to create or update a record in a key-value store.

Test Webhook

Tool to test a webhook by creating a test dispatch with a dummy payload.

Unlock Queue Requests

Tool to unlock requests in a request queue that are currently locked by the client.

Update Account Limits

Tool to update account limits manageable on the Limits page.

Update Actor

Tool to update Actor settings using JSON payload.

Update Actor Run Status Message

Updates the status message of an active Actor run to provide real-time progress updates visible in the Apify Console, helping you monitor and communicate the current state of execution.

Update Actor Task

Update settings of an existing scraping or automation task by specifying only the properties you want to change, which is useful for adjusting inputs, schedules, or execution options without recreating the task.

Update Actor Version

Tool to update an Actor version's configuration and source code.

Update Actor Version Environment Variable

Tool to update environment variable for a specific Actor version using JSON payload.

Update Dataset

Tool to update a dataset's name via JSON payload.

Update Key-Value Store

Tool to update a key-value store's properties.

Update Request in Queue

Tool to update a request in a request queue.

Update Request Queue

Tool to update request queue name using JSON payload.

Update Schedule

Tool to update an existing schedule with new settings.

Update Task Input

Tool to update the input configuration of a specific Actor task.

Update Webhook

Tool to update webhook using JSON payload.