Run Apify Actors and tasks, read their datasets, key-value stores and request queues, and manage builds, runs and schedules.
Explore 184 workflow actions for Apify, including account permissions and operation limits.
66 read actions118 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Abort Actor task's last run
Write
Aborts the last run of the specified Actor task and returns an object that contains all the details about the run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Abort Actor's last run
Write
Aborts the last run of the specified Actor and returns an object that contains all the details about the run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Abort build
Write
Aborts an Actor build and returns an object that contains all the details about the build.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Abort run
Write
Aborts an Actor run and returns an object that contains all the details about the run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add request
Write
Adds request to the queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add request to default request queue
Write
Adds a request to the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add request to last run's default request queue
Write
Adds a request to the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add request to last task run's default request queue
Write
Adds a request to the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add requests
Write
Adds requests to the queue in batch.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch add requests to default request queue
Write
Adds requests to the default request queue of the Actor run in batch.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch add requests to last run's default request queue
Write
Adds requests to the default request queue of the last Actor run in batch.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch add requests to last task run's default request queue
Write
Adds requests to the default request queue of the last Actor task run in batch.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch delete requests from default request queue
Write
Batch-deletes requests from the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch delete requests from last run's default request queue
Write
Batch-deletes requests from the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch delete requests from last task run's default request queue
Write
Batch-deletes requests from the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Build Actor
Write
Builds an Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Charge events in run
Write
Charge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event).
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create Actor
Write
Creates an Actor with the settings specified in an Actor object passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create dataset
Write
Creates a dataset and returns its object.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create key-value store
Write
Creates a key-value store and returns its object.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create request queue
Write
Creates a request queue and returns its object.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create schedule
Write
Creates a new schedule with settings provided by the schedule object passed as JSON in the payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create task
Write
Create a new task with settings specified by the object passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create version
Write
Creates a version of an Actor using values specified in a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Decode and verify object
Write
Decodes and verifies an encoded value previously created by the encode-and-sign endpoint.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete Actor
Write
Deletes an Actor with the specified ID.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete build
Write
Delete the build.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete dataset
Write
Deletes a specific dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete default dataset
Write
Deletes default dataset associated with an Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete default request queue
Write
Deletes the default request queue associated with an Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete default store
Write
Delete the default key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete default store's record
Write
Removes a record specified by a key from the default key-value store of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last run's default dataset
Write
Deletes the default dataset associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last run's default request queue
Write
Deletes the default request queue associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last run's default store
Write
Deletes the last Actor run key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last run's default store's record
Write
Removes a record specified by a key from the default key-value store of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last task run's default dataset
Write
Deletes the default dataset associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last task run's default request queue
Write
Deletes the default request queue associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last task run's default store
Write
Deletes the default key-value store of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete last task run's default store's record
Write
Removes a record specified by a key from the default key-value store of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lock on request in default request queue
Write
Deletes a request lock in the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lock on request in last run's default request queue
Write
Deletes a request lock in the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete lock on request in last task run's default request queue
Write
Deletes a request lock in the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete record
Write
Removes a record specified by a key from the key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete request
Write
Deletes given request from queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete request from default request queue
Write
Deletes a request from the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete request from last run's default request queue
Write
Deletes a request from the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete request from last task run's default request queue
Write
Deletes a request from the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete request lock
Write
Deletes a request lock.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete request queue
Write
Deletes given queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete requests
Write
Batch-deletes given requests from the queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete run
Write
Delete the run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete schedule
Write
Deletes a schedule.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete store
Write
Deletes a key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete task
Write
Delete the task specified through the actorTaskId parameter.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete version
Write
Deletes a specific version of Actor's source code.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Encode and sign object
Write
Encodes and signs any JSON object.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get Actor
Read
Gets an object that contains all the details about the Actor with the specified ID.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get and lock default request queue head
Read
Returns the given number of first requests from the default request queue of the Actor run and locks them for the given time.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get and lock last run's default request queue head
Read
Returns the given number of first requests from the default request queue of the last Actor run and locks them for the given time.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get and lock last task run's default request queue head
Read
Returns the given number of first requests from the default request queue of the last Actor task run and locks them for the given time.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get browser info (browser-info) DELETE
Write
Returns information about the HTTP request, including the client IP address, country code, request headers, and body length.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get browser info (browser-info) GET
Read
Returns information about the HTTP request, including the client IP address, country code, request headers, and body length.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get browser info (browser-info) POST
Read
Returns information about the HTTP request, including the client IP address, country code, request headers, and body length.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get browser info (browser-info) PUT
Write
Returns information about the HTTP request, including the client IP address, country code, request headers, and body length.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get build
Read
Gets an object that contains all the details about a specific build of an Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get dataset
Read
Returns dataset object for given dataset ID.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get dataset items
Read
Read the items of a dataset as JSON.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get dataset statistics
Read
Returns statistics for given dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default build
Read
Get the default build for an Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default dataset
Read
Returns the default dataset associated with an Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default dataset statistics
Read
Returns statistics for the Actor run's default dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default request queue
Read
Returns the default request queue associated with an Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default request queue head
Read
Returns the given number of first requests from the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default store
Read
Gets an object that contains all the details about the default key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get default store's list of keys
Read
Returns a list of keys for the default key-value store of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get head
Read
Returns given number of first requests from the queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get head and lock
Read
Returns the given number of first requests from the queue and locks them for the given time.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run (actor-tasks)
Read
This is not a single endpoint, but an entire group of endpoints that lets you to retrieve and manage the last run of given actor task or any of its default storages.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run (actors)
Read
This is not a single endpoint, but an entire group of endpoints that lets you to retrieve and manage the last run of given Actor or any of its default storages.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run's dataset statistics
Read
Returns statistics for the last Actor run's default dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run's default dataset
Read
Returns the default dataset associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run's default request queue
Read
Returns the default request queue associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run's default request queue head
Read
Returns the given number of first requests from the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run's default store
Read
Gets an object that contains all the details about the default key-value store associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last run's default store's list of keys
Read
Returns a list of keys for the default key-value store of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last task run's dataset statistics
Read
Returns statistics for the last Actor task run's default dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last task run's default dataset
Read
Returns the default dataset associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last task run's default request queue
Read
Returns the default request queue associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last task run's default request queue head
Read
Returns the given number of first requests from the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last task run's default store
Read
Gets an object that contains all the details about the default key-value store of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get last task run's default store's list of keys
Read
Returns a list of keys for the default key-value store of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get limits
Read
Returns a complete summary of your account's limits.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of Actors
Read
Gets the list of all Actors that the user created or used.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of Actors in Store
Read
Gets the list of public Actors in Apify Store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of builds
Read
Gets the list of builds of a specific Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of datasets
Read
Lists all of a user's datasets.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of key-value stores
Read
Gets the list of key-value stores owned by the user.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of keys
Read
Returns a list of objects describing keys of a given key-value store, as well as some information about the values (e.g.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of request queues
Read
Lists all of a user's request queues.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of runs
Read
Gets the list of runs of a specific Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of schedules
Read
Gets the list of schedules that the user created.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of task runs
Read
Get a list of runs of a specific task.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of tasks
Read
Gets the complete list of tasks that a user has created or used.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get list of versions
Read
Gets the list of versions of a specific Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get monthly usage
Read
Returns a complete summary of your usage for the current monthly usage cycle, an overall sum, as well as a daily breakdown of usage.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get private user data
Read
Returns information about the current user account, including both public and private information.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get public user data
Read
Returns public information about a specific user account, similar to what can be seen on public profile pages (e.g.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get request
Read
Returns request from queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get request from default request queue
Read
Returns a request from the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get request from last run's default request queue
Read
Returns a request from the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get request from last task run's default request queue
Read
Returns a request from the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get request queue
Read
Returns queue object for given queue ID.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get run
Read
This is not a single endpoint, but an entire group of endpoints that lets you retrieve the run or any of its default storages.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get schedule
Read
Gets the schedule object with all details.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get schedule log
Read
Gets the schedule log as a JSON array containing information about up to a 1000 invocations of the schedule.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get store
Read
Gets an object that contains all the details about a specific key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get task
Read
Get an object that contains all the details about a task.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get user builds list
Read
Gets a list of all builds for a user.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get user runs list
Read
Gets a list of all runs for a user.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Get version
Read
Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor.
Permissions and limits
Account permissions
An Apify API token with access to the resource
List default request queue's requests
Read
Returns a list of requests from the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
List last run's default request queue's requests
Read
Returns a list of requests from the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
List last task run's default request queue's requests
Read
Returns a list of requests from the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
List requests
Read
Returns a list of requests.
Permissions and limits
Account permissions
An Apify API token with access to the resource
Metamorph Actor task's last run
Write
Transforms the last run of the specified Actor task into a run of another Actor with a new input.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Metamorph Actor's last run
Write
Transforms the last run of the specified Actor into a run of another Actor with a new input.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Metamorph run
Write
Transforms an Actor run into a run of another Actor with a new input.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Prolong lock on request in default request queue
Write
Prolongs a request lock in the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Prolong lock on request in last run's default request queue
Write
Prolongs a request lock in the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Prolong lock on request in last task run's default request queue
Write
Prolongs a request lock in the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Prolong request lock
Write
Prolongs request lock.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reboot Actor task's last run
Write
Reboots the last run of the specified Actor task and returns an object that contains all the details about the rebooted run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reboot Actor's last run
Write
Reboots the last run of the specified Actor and returns an object that contains all the details about the rebooted run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reboot run
Write
Reboots an Actor run and returns an object that contains all the details about the rebooted run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resurrect run (actor-runs)
Write
Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resurrect run (actors)
Write
[DEPRECATED] API endpoints related to run of the Actor were moved under new namespace [actor-runs](#/reference/actor-runs).Resurrects a finished Actor run and returns an object.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run Actor
Write
Runs an Actor and immediately returns without waiting for the run to finish.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run Actor and get dataset items
Write
Run an Actor with the given input, wait for it to finish (up to 300 seconds) and get its dataset items; each run is billed.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run Actor synchronously and return key-value store record
Write
Runs a specific Actor and returns a key-value store record.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run task
Write
Runs an Actor task and immediately returns without waiting for the run to finish.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run task synchronously
Write
Runs an Actor task and synchronously returns a key-value store record.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run task synchronously and get dataset items
Write
Runs an Actor task and synchronously returns its dataset items.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store items (actor-runs)
Write
Appends an item or an array of items to the end of the Actor run's default dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store items (datasets)
Write
Appends an item or an array of items to the end of the dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store items in last run's dataset
Write
Appends an item or an array of items to the end of the last Actor run's default dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store items in last task run's dataset
Write
Appends an item or an array of items to the end of the last Actor task run's default dataset.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record
Write
Stores a value under a specific key to the key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record (POST)
Write
Stores a value under a specific key to the key-value store.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record in default store
Write
Stores a value under a specific key in the default key-value store of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record in default store (POST)
Write
Stores a value under a specific key in the default key-value store of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record in last run's default store
Write
Stores a value under a specific key in the default key-value store of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record in last run's default store (POST)
Write
Stores a value under a specific key in the default key-value store of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record in last task run's default store
Write
Stores a value under a specific key in the default key-value store of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Store record in last task run's default store (POST)
Write
Stores a value under a specific key in the default key-value store of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlock requests
Write
Unlocks requests in the queue that are currently locked by the client.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlock requests in default request queue
Write
Unlocks requests in the default request queue of the Actor run that are currently locked by the client.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlock requests in last run's default request queue
Write
Unlocks requests in the default request queue of the last Actor run that are currently locked by the client.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unlock requests in last task run's default request queue
Write
Unlocks requests in the default request queue of the last Actor task run that are currently locked by the client.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update Actor
Write
Updates an Actor's settings with the values specified in an Actor object passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update dataset
Write
Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update default dataset
Write
Updates the default dataset associated with an Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update default request queue
Write
Updates the default request queue associated with an Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update default store
Write
Updates the default key-value store's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update last run's default dataset
Write
Updates the default dataset associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update last run's default request queue
Write
Updates the default request queue associated with the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update last run's default store
Write
Updates the last Actor run key-value store's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update last task run's default dataset
Write
Updates the default dataset associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update last task run's default request queue
Write
Updates the default request queue associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update last task run's default store
Write
Updates the default key-value store associated with the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update limits
Write
Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits).
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update request
Write
Updates a request in a queue.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update request in default request queue
Write
Updates a request in the default request queue of the Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update request in last run's default request queue
Write
Updates a request in the default request queue of the last Actor run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update request in last task run's default request queue
Write
Updates a request in the default request queue of the last Actor task run.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update request queue
Write
Updates a request queue's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update run
Write
This endpoint can be used to update both the run's status message and to configure its general resource access level.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update schedule
Write
Updates a schedule using values specified by a schedule object passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update store
Write
Updates a key-value store's name and general resource access level using a value specified by a JSON object passed in the PUT payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update task
Write
Update settings of a task using values specified by an object passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update task input
Write
Updates the input of a task using values specified by an object passed as JSON in the PUT payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update version
Write
Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update version (POST)
Write
Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
Validate Actor input
Write
Validates the JSON payload against the Actor's [input schema](https://docs.apify.com/actors/development/actor-definition/input-schema) defined in the specified build.
Permissions and limits
Account permissions
An Apify API token with access to the resource
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Apify. A saved workflow is not a completed provider action.