Apify

Tool to abort an Actor build using the deprecated endpoint. Use when you need to cancel a build in progress. Only builds with STARTING or RUNNING status are aborted; builds in terminal states (FINISHED, FAILED, ABORTING, TIMED-OUT) are not affected. Note: This endpoint is deprecated; use ActorBuildAbortPost for the new endpoint.

Tool to get detailed information about a specific Actor build by actor ID and build ID. Use when you need to retrieve complete build details. Optionally wait for the build to finish using the waitForFinish parameter to avoid polling.

Tool to build an Actor with specified configuration. Use when you need to create a new build of an Actor with a specific version. The build process compiles the Actor's source code into a Docker image.

Tool to abort an Actor build that is starting or running. Use when you need to cancel a build in progress. Builds in terminal states (FINISHED, FAILED, ABORTING, TIMED-OUT) are not affected.

Tool to delete an Actor build permanently. Use when you need to remove a specific build by its ID. The default build for an Actor cannot be deleted. Only users with build permissions can delete builds.

Tool to get detailed information about a specific Actor build. Use when you need to retrieve complete build details by build ID. Optionally wait for the build to finish using the waitForFinish parameter to avoid polling.

Tool to retrieve the log file for a specific Actor build. Use when you need to inspect logs generated during an Actor build process. Only the trailing 5 million characters of the log are stored.

Tool to get the OpenAPI definition for a specific Actor build. Use when you need the API schema for a build identified by its unique buildId. Authentication is based on the build's unique ID; no authentication token is required.

Tool to get a paginated list of all builds for a user. Use when you need to retrieve build history across all actors. Supports pagination up to 1000 records.

Tool to abort a running or starting Actor run. Use when you need to stop an Actor run that is currently in STARTING or RUNNING status. For runs with status FINISHED, FAILED, ABORTING, and TIMED-OUT this call does nothing.

Tool to delete a finished Actor run. Use when you need to permanently remove a completed run. Only finished runs can be deleted by the initiating user or organization.

Tool to get details about a specific Actor run. Use when you need to retrieve comprehensive information about a run including its execution status, resource usage, storage IDs, and metadata.

Tool to update the status message of an Actor run. Use when you need to set progress information or status updates that will be displayed in the Apify Console UI during Actor execution.

Tool to delete an Actor task permanently. Use when you need to remove a task by its ID or username~taskName. Confirm before calling.

Tool to get complete details about an Actor task. Use when you need to retrieve task configuration, input settings, or metadata by task ID or username~task-name.

Tool to update Actor task settings using JSON payload. Only specified properties are updated; others remain unchanged. Use when you need to modify task configuration, input, or execution options.

Tool to get the most recent run of a specific Actor task. Use when you need to retrieve the last execution details. You can filter by status to get only successful runs using status='SUCCEEDED'.

Tool to run a specific task synchronously and return its output. Use when immediate task results are needed with pre-configured settings. The run must finish within 300 seconds otherwise the HTTP request fails with a timeout error.

Tool to run an actor task synchronously and retrieve its dataset items. Use when immediate access to task run results is needed. The run must finish within 300 seconds otherwise the request times out.

Tool to run an actor task synchronously with input overrides and retrieve its dataset items. Use when you need to override task input configuration and get immediate results. The run must finish within 300 seconds otherwise the request times out.

Tool to run an Actor task synchronously with input override and return its output. Use when immediate task results are needed with custom input parameters. The run must finish within 300 seconds otherwise the HTTP request fails with a timeout error (though the run continues server-side).

Tool to update Actor settings using JSON payload. Only specified fields will be updated. Use when you need to modify Actor configuration, make an Actor public, or update version settings.

Tool to abort an Actor run using the deprecated endpoint. Use when you need to stop an Actor run that is currently in STARTING or RUNNING status. For runs with status FINISHED, FAILED, ABORTING, and TIMED-OUT this call does nothing. Note: This endpoint is deprecated; use ActorRunAbortPost for the new endpoint.

Tool to get details about a specific Actor run using the deprecated /acts endpoint. Use when you need to retrieve comprehensive information about a run including its execution status, resource usage, storage IDs, and metadata. Note: This endpoint is deprecated; prefer using the actor-runs endpoint instead.

Tool to resurrect a finished Actor run using the deprecated endpoint. Use when you need to restart a completed, failed, aborted, or timed-out run. This endpoint is deprecated; prefer using the actor-runs namespace instead.

Tool to get the most recent run of a specific Actor. Use when you need to retrieve the last execution details of an Actor and optionally filter by status (e.g., status='SUCCEEDED' to get only the last successful run).

Tool to run a specific Actor synchronously without input and return its output. Use when immediate Actor results are needed without providing input data; the run must finish within 300 seconds otherwise the HTTP request fails with a timeout error.

Tool to run Actor synchronously without input and get dataset items. Use when immediate access to Actor results is needed without providing input. The run must finish within 300 seconds otherwise the request times out.

Tool to get the list of all Actors that the user created or used. Use when you need to enumerate or browse Actors. Add my=1 to get only user-created Actors.

Tool to delete a specific version of an Actor's source code. Use when you need to remove an Actor version by actor ID and version number. Confirm before calling.

Tool to delete an environment variable from a specific Actor version. Use when removing environment variables from Actor versions.

Tool to get environment variable details for a specific Actor version. Use when retrieving environment variable information from an Actor version. Returns name, value (if not secret), and secret status.

Tool to update environment variable for a specific Actor version using JSON payload. Only specified fields will be updated. Use when modifying existing environment variables in Actor versions.

Tool to get the list of environment variables for a specific Actor version. Use when you need to retrieve environment variable configurations for an Actor version.

Tool to create an environment variable for a specific Actor version. Use when adding new environment variables to Actor versions. Requires name and value parameters.

Tool to get details about a specific version of an Actor. Use when you need version metadata including source type, build tag, and configuration details.

Tool to update an Actor version's configuration and source code. Use when modifying version properties such as buildTag, sourceType, or environment variables. Only specified properties will be updated.

Tool to get the list of versions of a specific Actor. Use when you need to retrieve version metadata including source type, version number, and configuration details.

Tool to create a new version of an Actor. Use when you need to add a new version with specific source code location and configuration. Requires versionNumber and sourceType parameters, plus conditional parameters based on the sourceType.

Tool to get a list of webhooks for a specific Actor. Use when you need to review or manage webhooks configured for an Actor.

Tool to create a new Actor with specified configuration. Use when you need to initialize a fresh Actor programmatically before publishing or running it.

Tool to create a new dataset. Use when you need to initialize or retrieve a dataset by name.

Tool to create a new Actor task with specified settings. Use when you need to configure or schedule recurring Actor runs programmatically.

Tool to create a webhook for an Actor task. Use when you need external notifications about task run events (e.g., completion or failure) in downstream systems.

Tool to delete a dataset permanently. Use when you need to remove a dataset by its ID or username~dataset-name. Confirm before calling.

Tool to retrieve dataset metadata by dataset ID. Use when you need information about a dataset's structure, item counts, or access URLs. This does not return dataset items themselves.

Tool to update a dataset's name via JSON payload. Use when you need to rename an existing dataset.

Tool to get list of datasets for a user. Use when you need to enumerate or browse user's datasets. Supports pagination with up to 1000 items per page.

Tool to get dataset field statistics by dataset ID. Use when you need statistical information about dataset fields including min, max, null count, and empty count. Only provides field statistics when dataset schema is configured.

Tool to delete an Actor permanently. Use when you need to remove an Actor by its ID or username~actorName. Confirm before calling.

Tool to delete a webhook by its ID. Use when removing a webhook after confirming the webhook ID.

Tool to get details of a specific Actor. Use when you need actor metadata by ID or username/actorName.

Tool to get a list of all webhooks created by the user. Use when you need to enumerate webhooks before filtering or maintenance.

Tool to retrieve items from a dataset. Use when you need to fetch data from a specified dataset by pagination or filtering. Only JSON format is fully supported.

Tool to get the default build for an Actor. Use after specifying the Actor ID; optionally wait for the build to finish before returning.

Tool to retrieve a record from a key-value store. Use when you need to fetch a specific value by key from an Apify Key-Value Store.

Tool to get a list of builds for a specific Actor. Use when you need paginated access to an Actor’s build (version) history.

Tool to get a list of runs for a specific Actor. Use when you need to paginate through runs and optionally filter by status before processing run data.

Tool to get a list of runs for a specific Actor task. Use when you need to paginate through task runs and optionally filter by status.

Tool to fetch a paginated list of tasks belonging to the authenticated user. Use when you need to browse or sort tasks created by the user.

Tool to get a list of webhooks for a specific Actor task. Use when you need to review or paginate webhooks after creating or updating a task.

Tool to retrieve logs for a specific Actor run or build. Use after initiating an actor run or build when you need to inspect execution logs.

Tool to get the OpenAPI definition for a specific Actor build. Use when you need the API schema for code generation or analysis.

Tool to retrieve the input configuration of a specific task. Use when you need to inspect stored task input before execution or debugging.

Tool to delete a key-value store permanently. Use when you need to remove a key-value store by its ID. Confirm before calling.

Tool to retrieve key-value store metadata by store ID. Use when you need detailed information about a specific key-value store including stats and access URLs.

Tool to retrieve a list of keys from a key-value store. Use when you need to list keys in a store with optional filtering and pagination support.

Tool to delete a record from a key-value store. Use when you need to remove a specific record by its key from an Apify Key-Value Store.

Tool to check if a record exists in a key-value store. Use when you need to verify whether a specific key exists in an Apify Key-Value Store without retrieving its content.

Tool to get the list of key-value stores owned by the user. Use when you need to enumerate or browse available stores. Supports pagination up to 1000 records per request.

Tool to create a new key-value store or retrieve an existing one by name. Use when you need to initialize a store for saving data records or files. If a store with the given name already exists, returns that store instead of creating a duplicate.

Tool to delete a request queue permanently. Use when you need to remove a request queue by its ID.

Tool to retrieve request queue metadata by queue ID. Use when you need information about a specific request queue including its statistics and request counts.

Tool to retrieve first requests from the queue for inspection. Use when you need to examine pending requests without locking them.

Tool to get and lock head requests from the queue. Returns the given number of first requests from the queue and locks them for the given time, preventing other clients from accessing them during the lock period. Use when you need to process requests exclusively without concurrent access by other clients.

Tool to update request queue name using JSON payload. Use when you need to rename an existing request queue.

Tool to delete a specific request from a request queue. Use when you need to remove a request by its ID from an Apify request queue.

Tool to retrieve a specific request from a request queue by its ID. Use when you need to get detailed information about a request in an Apify request queue.

Tool to delete a request lock from a request queue. Use when you need to unlock a previously locked request. Only the client that locked the request can delete its lock.

Tool to prolong request lock in a request queue. Use when you need to extend the lock duration on a previously locked request. Only the client that locked the request can prolong its lock.

Tool to update a request in a request queue. Use when you need to modify request properties or mark a request as handled by setting handledAt to the current date/time. If handledAt is set, the request will be removed from the head of the queue and unlocked if applicable.

Tool to batch-delete up to 25 requests from a queue. Use when you need to remove multiple requests efficiently. Failed requests due to rate limits should be retried with exponential backoff.

Tool to batch-add up to 25 requests to a request queue. Use when you need to add multiple requests efficiently. Failed requests due to rate limits should be retried with exponential backoff.

Tool to list requests in a request queue with pagination support. Use when you need to retrieve multiple requests from an Apify request queue.

Tool to add a request to the queue. Use when you need to add a web page URL to a request queue for crawling. If a request with the same uniqueKey was already present in the queue, returns the ID of the existing request.

Tool to unlock requests in a request queue that are currently locked by the client. If the client is within an Actor run, unlocks all requests locked by that specific run plus all requests locked by the same clientKey. If the client is outside of an Actor run, unlocks all requests locked using the same clientKey.

Tool to get list of request queues for a user. Use when you need to enumerate or browse user's request queues. Supports pagination with up to 1000 items per page.

Tool to create a new request queue or retrieve an existing one by name. Use when you need to initialize a queue for storing and managing web scraping requests. If a queue with the given name already exists, returns that queue instead of creating a duplicate. Unnamed queues follow data retention period policies.

Tool to resurrect a finished Actor run. Use when you need to restart a completed or failed run. Deprecated endpoint; may be removed in future.

Tool to run a specific Actor asynchronously. Use when you need to trigger an Actor run without waiting for completion and retrieve its run details immediately.

Tool to run a specific Actor synchronously with input and return its output record. Use when immediate Actor results are needed; runs may timeout after 300 seconds.

Tool to run an Actor synchronously and retrieve its dataset items. Use when immediate access to run results is needed.

Tool to run a specific Actor task asynchronously. Use when you need to trigger a task run without waiting for completion and immediately retrieve its run details.

Tool to delete a schedule by its ID. Use when you need to remove a schedule from the Apify system.

Tool to get schedule details by ID. Use when you need to retrieve comprehensive information about a schedule including cron expression, timezone, actions, and execution times.

Tool to get schedule log by ID. Use when you need to retrieve execution history for a schedule, including invocation timestamps and status messages. Returns up to 1000 invocations.

Tool to update an existing schedule with new settings. Use when you need to modify schedule properties like cron expression, timezone, enabled status, or actions. Only specified fields are updated; others remain unchanged.