Apify

# Apify Documentation


## Apify API

- [Apify API](https://docs.apify.com/api.md)
- [Apify API](https://docs.apify.com/api/v2.md): The Apify API (version 2) provides programmatic access to the [Apify platform](https://docs.apify.com).
    - [Abort build](https://docs.apify.com/api/v2/act-build-abort-post.md): :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API.
    - [Get default build](https://docs.apify.com/api/v2/act-build-default-get.md): Clients Python JavaScriptGet the default build for an Actor.
    - [Get build](https://docs.apify.com/api/v2/act-build-get.md): :::caution deprecated API endpoints related to build of the Actor were moved under new namespace [`actor-builds`](#/reference/actor-builds).
    - [Get list of builds](https://docs.apify.com/api/v2/act-builds-get.md): Clients Python JavaScriptGets the list of builds of a specific Actor.
    - [Build Actor](https://docs.apify.com/api/v2/act-builds-post.md): Clients Python JavaScriptBuilds an Actor.
    - [Delete Actor](https://docs.apify.com/api/v2/act-delete.md): Clients JavaScriptDeletes an Actor.
    - [Get Actor](https://docs.apify.com/api/v2/act-get.md): Clients Python JavaScriptGets an object that contains all the details about a specific Actor.
    - [Get OpenAPI definition](https://docs.apify.com/api/v2/act-openapi-json-get.md): Get the OpenAPI definition for Actor builds.
    - [Update Actor](https://docs.apify.com/api/v2/act-put.md): Clients Python JavaScriptUpdates settings of an Actor using values specified by an Actor object passed as JSON in the POST payload.
    - [Abort run](https://docs.apify.com/api/v2/act-run-abort-post.md): :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API.
    - [Get run](https://docs.apify.com/api/v2/act-run-get.md): :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API.
    - [Metamorph run](https://docs.apify.com/api/v2/act-run-metamorph-post.md): :::caution deprecated This endpoint has been deprecated and may be replaced or removed in future versions of the API.
    - [Resurrect run](https://docs.apify.com/api/v2/act-run-resurrect-post.md): **[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 that contains all the details about the resurrected run.
    - [Without input](https://docs.apify.com/api/v2/act-run-sync-get.md): Runs a specific Actor and returns its output.
    - [Run Actor synchronously without input and get dataset items](https://docs.apify.com/api/v2/act-run-sync-get-dataset-items-get.md): Runs a specific Actor and returns its dataset items.
    - [Run Actor synchronously with input and get dataset items](https://docs.apify.com/api/v2/act-run-sync-get-dataset-items-post.md): Runs a specific Actor and returns its dataset items.
    - [Run Actor synchronously with input and return output](https://docs.apify.com/api/v2/act-run-sync-post.md): Runs a specific Actor and returns its output.
    - [Get list of runs](https://docs.apify.com/api/v2/act-runs-get.md): Clients Python JavaScriptGets the list of runs of a specific Actor.
    - [Get last run](https://docs.apify.com/api/v2/act-runs-last-get.md): 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.
    - [Run Actor](https://docs.apify.com/api/v2/act-runs-post.md): Clients Python JavaScriptRuns an Actor and immediately returns without waiting for the run to finish.
    - [Delete version](https://docs.apify.com/api/v2/act-version-delete.md): Deletes a specific version of Actor's source code.
    - [Delete environment variable](https://docs.apify.com/api/v2/act-version-env-var-delete.md): Deletes a specific environment variable.
    - [Get environment variable](https://docs.apify.com/api/v2/act-version-env-var-get.md): Clients PythonGets a [EnvVar object](#/reference/actors/environment-variable-object) that contains all the details about a specific environment variable of an Actor.
    - [Update environment variable](https://docs.apify.com/api/v2/act-version-env-var-put.md): Clients PythonUpdates Actor environment variable using values specified by a [EnvVar object](#/reference/actors/environment-variable-object) passed as JSON in the POST payload.
    - [Get list of environment variables](https://docs.apify.com/api/v2/act-version-env-vars-get.md): Clients PythonGets the list of environment variables for a specific version of an Actor.
    - [Create environment variable](https://docs.apify.com/api/v2/act-version-env-vars-post.md): Clients PythonCreates an environment variable of an Actor using values specified in a [EnvVar object](#/reference/actors/environment-variable-object) passed as JSON in the POST payload.
    - [Get version](https://docs.apify.com/api/v2/act-version-get.md): Clients PythonGets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor.
    - [Update version](https://docs.apify.com/api/v2/act-version-put.md): Clients PythonUpdates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
    - [Get list of versions](https://docs.apify.com/api/v2/act-versions-get.md): Clients PythonGets the list of versions of a specific Actor.
    - [Create version](https://docs.apify.com/api/v2/act-versions-post.md): Clients PythonCreates a version of an Actor using values specified in a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.
    - [Get list of webhooks](https://docs.apify.com/api/v2/act-webhooks-get.md): Gets the list of webhooks of a specific Actor.
    - [Abort build](https://docs.apify.com/api/v2/actor-build-abort-post.md): Clients Python JavaScriptAborts an Actor build and returns an object that contains all the details about the build.
    - [Delete build](https://docs.apify.com/api/v2/actor-build-delete.md): Clients JavaScriptDelete the build.
    - [Get build](https://docs.apify.com/api/v2/actor-build-get.md): Clients Python JavaScriptGets an object that contains all the details about a specific build of an Actor.
    - [Get log](https://docs.apify.com/api/v2/actor-build-log-get.md): Check out [Logs](#/reference/logs) for full reference.
    - [Get OpenAPI definition](https://docs.apify.com/api/v2/actor-build-openapi-json-get.md): Clients Python JavaScriptGet the OpenAPI definition for Actor builds.
    - [Actor builds - Introduction](https://docs.apify.com/api/v2/actor-builds.md): The API endpoints described in this section enable you to manage, and delete Apify Actor builds.
    - [Get user builds list](https://docs.apify.com/api/v2/actor-builds-get.md): Gets a list of all builds for a user.
    - [Abort run](https://docs.apify.com/api/v2/actor-run-abort-post.md): Clients Python JavaScriptAborts an Actor run and returns an object that contains all the details about the run.
    - [Delete run](https://docs.apify.com/api/v2/actor-run-delete.md): Clients JavaScriptDelete the run.
    - [Get run](https://docs.apify.com/api/v2/actor-run-get.md): This is not a single endpoint, but an entire group of endpoints that lets you retrieve the run or any of its default storages.
    - [Metamorph run](https://docs.apify.com/api/v2/actor-run-metamorph-post.md): Clients Python JavaScriptTransforms an Actor run into a run of another Actor with a new input.
    - [Update status message](https://docs.apify.com/api/v2/actor-run-put.md): You can set a single status message on your run that will be displayed in the Apify Console UI.
    - [Reboot run](https://docs.apify.com/api/v2/actor-run-reboot-post.md): Clients Python JavaScriptReboots an Actor run and returns an object that contains all the details about the rebooted run.
    - [Actor runs - Introduction](https://docs.apify.com/api/v2/actor-runs.md): The API endpoints described in this section enable you to manage, and delete Apify Actor runs.
    - [Get user runs list](https://docs.apify.com/api/v2/actor-runs-get.md): Gets a list of all runs for a user.
    - [Delete task](https://docs.apify.com/api/v2/actor-task-delete.md): Clients JavaScriptDelete the task specified through the `actorTaskId` parameter.
    - [Get task](https://docs.apify.com/api/v2/actor-task-get.md): Clients Python JavaScriptGet an object that contains all the details about a task.
    - [Get task input](https://docs.apify.com/api/v2/actor-task-input-get.md): Clients Python JavaScriptReturns the input of a given task.
    - [Update task input](https://docs.apify.com/api/v2/actor-task-input-put.md): Clients Python JavaScriptUpdates the input of a task using values specified by an object passed as JSON in the PUT payload.
    - [Update task](https://docs.apify.com/api/v2/actor-task-put.md): Clients Python JavaScriptUpdate settings of a task using values specified by an object passed as JSON in the POST payload.
    - [Run task synchronously](https://docs.apify.com/api/v2/actor-task-run-sync-get.md): Run a specific task and return its output.
    - [Run task synchronously and get dataset items](https://docs.apify.com/api/v2/actor-task-run-sync-get-dataset-items-get.md): Run a specific task and return its dataset items.
    - [Run task synchronously and get dataset items](https://docs.apify.com/api/v2/actor-task-run-sync-get-dataset-items-post.md): Runs an Actor task and synchronously returns its dataset items.
    - [Run task synchronously](https://docs.apify.com/api/v2/actor-task-run-sync-post.md): Runs an Actor task and synchronously returns its output.
    - [Get list of task runs](https://docs.apify.com/api/v2/actor-task-runs-get.md): Get a list of runs of a specific task.
    - [Get last run](https://docs.apify.com/api/v2/actor-task-runs-last-get.md): 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.
    - [Run task](https://docs.apify.com/api/v2/actor-task-runs-post.md): Clients Python JavaScriptRuns an Actor task and immediately returns without waiting for the run to finish.
    - [Get list of webhooks](https://docs.apify.com/api/v2/actor-task-webhooks-get.md): Gets the list of webhooks of a specific Actor task.
    - [Actor tasks - Introduction](https://docs.apify.com/api/v2/actor-tasks.md): The API endpoints described in this section enable you to create, manage, delete, and run Apify Actor tasks.
    - [Get list of tasks](https://docs.apify.com/api/v2/actor-tasks-get.md): Clients Python JavaScriptGets the complete list of tasks that a user has created or used.
    - [Create task](https://docs.apify.com/api/v2/actor-tasks-post.md): Clients Python JavaScriptCreate a new task with settings specified by the object passed as JSON in the POST payload.
    - [Actors - Introduction](https://docs.apify.com/api/v2/actors.md): The API endpoints in this section allow you to manage Apify Actors.
    - [Actor builds - Introduction](https://docs.apify.com/api/v2/actors-actor-builds.md): The API endpoints in this section allow you to manage your Apify Actors builds.
    - [Actor runs - Introduction](https://docs.apify.com/api/v2/actors-actor-runs.md): The API endpoints in this section allow you to manage your Apify Actors runs.
    - [Actor versions - Introduction](https://docs.apify.com/api/v2/actors-actor-versions.md): The API endpoints in this section allow you to manage your Apify Actors versions.
    - [Webhook collection - Introduction](https://docs.apify.com/api/v2/actors-webhook-collection.md): The API endpoint in this section allows you to get a list of webhooks of a specific Actor.
    - [Get list of Actors](https://docs.apify.com/api/v2/acts-get.md): Clients Python JavaScriptGets the list of all Actors that the user created or used.
    - [Create Actor](https://docs.apify.com/api/v2/acts-post.md): Clients Python JavaScriptCreates a new Actor with settings specified in an Actor object passed as JSON in the POST payload.
    - [Delete dataset](https://docs.apify.com/api/v2/dataset-delete.md): Clients JavaScriptDeletes a specific dataset.
    - [Get dataset](https://docs.apify.com/api/v2/dataset-get.md): Clients Python JavaScriptReturns dataset object for given dataset ID.
    - [Get items](https://docs.apify.com/api/v2/dataset-items-get.md): Clients Python JavaScriptReturns data stored in the dataset in a desired format.
    - [Store items](https://docs.apify.com/api/v2/dataset-items-post.md): Clients Python JavaScriptAppends an item or an array of items to the end of the dataset.
    - [Update dataset](https://docs.apify.com/api/v2/dataset-put.md): Clients Python JavaScriptUpdates a dataset's name using a value specified by a JSON object passed in the PUT payload.
    - [Get dataset statistics](https://docs.apify.com/api/v2/dataset-statistics-get.md): Returns statistics for given dataset.
    - [Get list of datasets](https://docs.apify.com/api/v2/datasets-get.md): Clients Python JavaScriptLists all of a user's datasets.
    - [Create dataset](https://docs.apify.com/api/v2/datasets-post.md): Clients Python JavaScriptCreates a dataset and returns its object.
    - [Getting started with Apify API](https://docs.apify.com/api/v2/getting-started.md): The Apify API provides programmatic access to the [Apify platform](https://docs.apify.com).
    - [Delete store](https://docs.apify.com/api/v2/key-value-store-delete.md): Clients JavaScriptDeletes a key-value store.
    - [Get store](https://docs.apify.com/api/v2/key-value-store-get.md): Clients Python JavaScriptGets an object that contains all the details about a specific key-value store.
    - [Get list of keys](https://docs.apify.com/api/v2/key-value-store-keys-get.md): Clients Python JavaScriptReturns a list of objects describing keys of a given key-value store, as well as some information about the values (e.g.
    - [Update store](https://docs.apify.com/api/v2/key-value-store-put.md): Clients Python JavaScriptUpdates a key-value store's name using a value specified by a JSON object passed in the PUT payload.
    - [Delete record](https://docs.apify.com/api/v2/key-value-store-record-delete.md): Clients Python JavaScriptRemoves a record specified by a key from the key-value store.
    - [Get record](https://docs.apify.com/api/v2/key-value-store-record-get.md): Clients Python JavaScriptGets a value stored in the key-value store under a specific key.
    - [Check if a record exists](https://docs.apify.com/api/v2/key-value-store-record-head.md): Clients Python JavaScriptCheck if a value is stored in the key-value store under a specific key.
    - [Store record](https://docs.apify.com/api/v2/key-value-store-record-put.md): Clients Python JavaScriptStores a value under a specific key to the key-value store.
    - [Get list of key-value stores](https://docs.apify.com/api/v2/key-value-stores-get.md): Clients Python JavaScriptGets the list of key-value stores owned by the user.
    - [Create key-value store](https://docs.apify.com/api/v2/key-value-stores-post.md): Clients Python JavaScriptCreates a key-value store and returns its object.
    - [Get log](https://docs.apify.com/api/v2/log-get.md): Clients Python JavaScriptRetrieves logs for a specific Actor build or run.
    - [Logs - Introduction](https://docs.apify.com/api/v2/logs.md): The API endpoints described in this section are used the download the logs generated by Actor builds and runs.
    - [Charge events in run](https://docs.apify.com/api/v2/post-charge-run.md): Clients Python JavaScriptCharge for events in the run of your [pay per event Actor](https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event).
    - [Resurrect run](https://docs.apify.com/api/v2/post-resurrect-run.md): Clients Python JavaScriptResurrects a finished Actor run and returns an object that contains all the details about the resurrected run.
    - [Delete request queue](https://docs.apify.com/api/v2/request-queue-delete.md): Clients JavaScriptDeletes given queue.