Apify API
The Apify API (version 2) provides programmatic access to the [Apify platform](https://docs.apify.com). The API is organized around…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Apify API (version 2) provides programmatic access to the [Apify
platform](https://docs.apify.com). The API is organized
around RESTful
HTTP endpoints.
You can download the complete OpenAPI schema of Apify API in the YAML or JSON formats. The source code is also available on GitHub.
All requests and responses (including errors) are encoded in
JSON format with UTF-8 encoding,
with a few exceptions that are explicitly described in the reference.
To access the API, we recommend using one of our API clients:
Stable API clients:
- For Node.js, we recommend the
apify-client[NPM
package](https://www.npmjs.com/package/apify-client).
- For Python, we recommend the
apify-client[PyPI
package](https://pypi.org/project/apify-client/).
Experimental API clients:
- For Java, we recommend the
apify-clientMaven central component. - For Rust, we recommend the
apify-clientcrate. - For .NET, we recommend the
apify-clientNuget package. - For PHP, we recommend the
apify-clientPackagist package. - For Go, we recommend the
apify-clientpackage.
The clients' functions correspond to the API endpoints and have the same
parameters. This simplifies development of apps that depend on the Apify
platform.
:::note Important Request Details
Content-Typeheader: For requests with a JSON body, you must include theContent-Type: application/jsonheader.
- Method override: You can override the HTTP method using the
methodquery parameter. This is useful for clients that can only sendGETrequests. For example, to call aPOSTendpoint, append?method=POSTto the URL of yourGETrequest.
:::
Authentication
**You can create an API token on the
Integrations page in the
Apify Console.** The Console shows the token only once, right after you create
or rotate it, so copy it and store it somewhere safe. For details, see
API token.
To use your token in a request, either:
- _(Recommended)_ Add the token to your request's
Authorizationheader asBearer.
E.g., Authorization: Bearer xxxxxxx.
For details, see the Authorization header on MDN.
- Add it as the
tokenparameter to your request URL. (Less secure).
Using your token in the request header is more secure than using it as a URL
parameter because URLs are often stored
in browser history and server logs. This creates a chance for someone
unauthorized to access your API token.
Never share your API token or password with untrusted parties!
For more information, see our
integrations documentation.
Agentic payments
AI agents can authenticate and pay for Actor runs without an Apify account
using agentic payments. Instead of an API token, the request carries a
payment credential that both authorizes and pays for the call. Apify supports
the x402 protocol
(PAYMENT-SIGNATURE header) and
Skyfire
(skyfire-pay-id header).
Agents can also pay once with x402 or the
Machine Payments Protocol (MPP)
and receive a temporary API token with a fixed spend cap from the Apify
Agent General Interface (AGI) at
https://agi.apify.com. Use that token as a regularBearer token.
Basic usage
To run an Actor, send a POST request to the Run Actor endpoint using either the
Actor ID code (e.g. vKg4IjxZbEYTYeW8T) or its name (e.g.janedoe~my-actor):
https://api.apify.com/v2/actors/[actor_id]/runs
If the Actor is not runnable anonymously, you will receive a 401 or 403
response code.
This means you need to add your [secret API
token](https://console.apify.com/account#/integrations) to the request'sAuthorization header (recommended) or as a
URL query parameter ?token=[your_token] (less secure).
Optionally, you can include the query parameters described in the [Run…
Endpoints 242
Actors
- GETGet list of Actors
/v2/actorsGets the list of all Actors that the user created or used. The response is a list of objects, where each object contains a basic information about a single… - POSTCreate Actor
/v2/actorsCreates an Actor with the settings specified in an Actor object passed as JSON in the POST payload. Returns the created Actor object. In the HTTP request, set… - GETGet Actor
/v2/actors/:actorIdGets an object that contains all the details about the Actor with the specified ID. - PUTUpdate Actor
/v2/actors/:actorIdUpdates an Actor's settings with the values specified in an Actor object passed as JSON in the POST payload. Only the fields specified in the request body are… - DELETEDelete Actor
/v2/actors/:actorIdDeletes an Actor with the specified ID. - GETGet list of Actor OAuth connections
/v2/actors/:actorId/oauth-connectionsGets the OAuth connections configured on the Actor. Each connection defines an OAuth provider that users of the Actor can connect their accounts through. Only… - POSTValidate Actor input
/v2/actors/:actorId/validate-inputValidates the JSON payload against the Actor's input schema defined in the specified build. If the specified build has no input schema, any input is… - GETGet list of Actor OAuth accounts
/v2/actor-oauth-accounts/:connectionId/accountsGets the accounts you connected through the Actor OAuth connection, including their OAuth tokens. Only accounts that finished authorization are returned.… - GETGet Actor OAuth account
/v2/actor-oauth-accounts/:accountIdGets an account connected through an Actor OAuth connection, including its OAuth tokens. This endpoint only accepts the API token of an Actor run (the…
Actors/Actor versions
- GETGet list of Actor versions
/v2/actors/:actorId/versionsGets the list of versions of a specific Actor. The response is a JSON object with the list of Version objects, where each contains basic information about a… - POSTCreate Actor version
/v2/actors/:actorId/versionsCreates a version of an Actor using values specified in a Version object passed as JSON in the POST payload. The request must specify versionNumber and… - GETGet Actor version
/v2/actors/:actorId/versions/:versionNumberGets a Version object that contains all the details about a specific version of an Actor. - PUTUpdate Actor version
/v2/actors/:actorId/versions/:versionNumberUpdates Actor version using values specified by a Version object passed as JSON in the POST payload. If the object does not define a specific property, its… - POSTUpdate Actor version (POST)
/v2/actors/:actorId/versions/:versionNumberUpdates Actor version using values specified by a Version object passed as JSON in the POST payload. This endpoint is an alias for the Update Actor version… - DELETEDelete Actor version
/v2/actors/:actorId/versions/:versionNumberDeletes a specific version of Actor's source code. - PUTUpdate Actor version build on push
/v2/actors/:actorId/versions/:versionNumber/build-on-pushTurns automatic builds on push on or off for an Actor version whose source is a git repository. Enabling registers a push webhook on the repository through… - GETGet list of environment variables of Actor version
/v2/actors/:actorId/versions/:versionNumber/env-varsGets the list of environment variables for a specific version of an Actor. The response is a JSON object with the list of EnvVar objects, where each contains… - POSTCreate environment variable in Actor version
/v2/actors/:actorId/versions/:versionNumber/env-varsCreates an environment variable of an Actor using values specified in an EnvVar object passed as JSON in the POST payload. The request must specify name and… - GETGet environment variable of Actor version
/v2/actors/:actorId/versions/:versionNumber/env-vars/:envVarNameGets an EnvVar object that contains all the details about a specific environment variable of an Actor. If isSecret is set to true, then value will never be… - PUTUpdate environment variable in Actor version
/v2/actors/:actorId/versions/:versionNumber/env-vars/:envVarNameUpdates Actor environment variable using values specified by an EnvVar object passed as JSON in the POST payload. If the object does not define a specific… - POSTUpdate environment variable in Actor version (POST)
/v2/actors/:actorId/versions/:versionNumber/env-vars/:envVarNameUpdates Actor environment variable using values specified by an EnvVar object passed as JSON in the POST payload. This endpoint is an alias for the Update… - DELETEDelete environment variable from Actor version
/v2/actors/:actorId/versions/:versionNumber/env-vars/:envVarNameDeletes a specific environment variable.
Actors/Actor builds
- GETGet list of Actor's builds
/v2/actors/:actorId/buildsGets the list of builds of a specific Actor. The response is a JSON with the list of objects, where each object contains basic information about a single… - POSTBuild Actor
/v2/actors/:actorId/builds?version=0.0Builds an Actor. The response is the build object as returned by the Get Actor build endpoint. - GETGet default Actor build
/v2/actors/:actorId/builds/defaultGet the default build for an Actor. Use the optional waitForFinish parameter to synchronously wait for the build to finish. This avoids the need for periodic… - GETGet OpenAPI definition of Actor build
/v2/actors/:actorId/builds/:buildId/openapi.jsonGet the OpenAPI definition for Actor builds. Two similar endpoints are available: Get OpenAPI definition of Actor build… - GETGet Actor build
/v2/actors/:actorId/builds/:buildIdDeprecated. By passing the optional waitForFinish parameter the API endpoint will synchronously wait for the build to finish. This is useful to avoid periodic… - POSTAbort Actor build
/v2/actors/:actorId/builds/:buildId/abortDeprecated. [DEPRECATED] API endpoints related to build of the Actor were moved under new namespace actor-builds (Manage Actor builds). Aborts an Actor build…
Actors/Actor runs
- GETGet list of Actor's runs
/v2/actors/:actorId/runsGets the list of runs of a specific Actor. The response is a list of objects, where each object contains basic information about a single Actor run. The… - POSTRun Actor
/v2/actors/:actorId/runsRuns an Actor and immediately returns without waiting for the run to finish. The POST payload including its Content-Type header is passed as INPUT to the… - GETRun Actor synchronously and get key-value store record (GET)
/v2/actors/:actorId/run-syncRuns a specific Actor and returns a key-value store record. The response contains the record stored under the OUTPUT key in the run's default key-value store.… - POSTRun Actor synchronously and get key-value store record
/v2/actors/:actorId/run-syncRuns a specific Actor and returns a key-value store record. The POST payload including its Content-Type header is passed as INPUT to the Actor (usually… - GETRun Actor synchronously and get dataset items (GET)
/v2/actors/:actorId/run-sync-get-dataset-itemsRuns a specific Actor and returns its dataset items. The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds otherwise the API endpoint… - POSTRun Actor synchronously and get dataset items
/v2/actors/:actorId/run-sync-get-dataset-itemsRuns a specific Actor and returns its dataset items. The POST payload including its Content-Type header is passed as INPUT to the Actor (usually… - POSTResurrect Actor run
/v2/actors/:actorId/runs/:runId/resurrect[DEPRECATED] API endpoints related to run of the Actor were moved under new namespace actor-runs (Manage Actor runs). Resurrects a finished Actor run and… - GETGet Actor's last run
/v2/actors/:actorId/runs/lastThis 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… - GETGet Actor run
/v2/actors/:actorId/runs/:runIdDeprecated. [DEPRECATED] API endpoints related to run of the Actor were moved under new namespace actor-runs (Manage Actor runs). Gets an object that contains… - POSTAbort Actor run
/v2/actors/:actorId/runs/:runId/abortDeprecated. [DEPRECATED] API endpoints related to run of the Actor were moved under new namespace actor-runs (Manage Actor runs). Aborts an Actor run and… - POSTMetamorph Actor run
/v2/actors/:actorId/runs/:runId/metamorph?targetActorId=HDSasDasz78YcAPEBDeprecated. [DEPRECATED] API endpoints related to run of the Actor were moved under new namespace actor-runs (Manage Actor runs). Transforms an Actor run into…
Actors/Webhook collection
- GETGet list of Actor's webhooks
/v2/actors/:actorId/webhooksGets the list of webhooks of a specific Actor. The response is a JSON with the list of objects, where each object contains basic information about a single…
Actor builds
- GETGet list of user's Actor builds
/v2/actor-buildsGets a list of all builds for a user. The response is a JSON array of objects, where each object contains basic information about a single build. The endpoint… - GETGet Actor build
/v2/actor-builds/:buildIdGets an object that contains all the details about a specific build of an Actor. By passing the optional waitForFinish parameter the API endpoint will… - DELETEDelete Actor build
/v2/actor-builds/:buildIdDelete the build. The build that is the current default build for the Actor cannot be deleted. Only users with build permissions for the Actor can delete… - POSTAbort Actor build
/v2/actor-builds/:buildId/abortAborts an Actor build and returns an object that contains all the details about the build. Only builds that are starting or running are aborted. For builds… - GETGet Actor build's log
/v2/actor-builds/:buildId/logRetrieves Actor build's logs. This endpoint is a shortcut for getting the build's log. Same as Get Actor build or run log endpoint. - GETGet OpenAPI definition of Actor build
/v2/actor-builds/:buildId/openapi.jsonGet the OpenAPI definition for Actor builds. Two similar endpoints are available: Get OpenAPI definition of Actor build…
Actor runs
- GETGet list of user's Actor runs
/v2/actor-runsGets a list of all runs for a user. The response is a list of objects, where each object contains basic information about a single Actor run. The endpoint… - GETGet Actor run
/v2/actor-runs/:runIdThis is not a single endpoint, but an entire group of endpoints that lets you retrieve the run or any of its default storages. Convenience endpoints for Actor… - PUTUpdate Actor run
/v2/actor-runs/:runIdThis endpoint can be used to update both the run's status message and to configure its general resource access level. Status message: You can set a single… - DELETEDelete Actor run
/v2/actor-runs/:runIdDelete the run. Only finished runs can be deleted. Only the person or organization that initiated the run can delete it. - POSTAbort Actor run
/v2/actor-runs/:runId/abortAborts an Actor run and returns an object that contains all the details about the run. Only runs that are starting or running are aborted. For runs with… - POSTMetamorph Actor run
/v2/actor-runs/:runId/metamorph?targetActorId=HDSasDasz78YcAPEBTransforms an Actor run into a run of another Actor with a new input. This is useful if you want to use another Actor to finish the work of your current Actor… - POSTReboot Actor run
/v2/actor-runs/:runId/rebootReboots an Actor run and returns an object that contains all the details about the rebooted run. Only runs that are running, i.e. runs with status RUNNING can… - POSTResurrect Actor run
/v2/actor-runs/:runId/resurrectResurrects a finished Actor run and returns an object that contains all the details about the resurrected run. Only finished runs, that is, runs with status… - POSTCharge events in Actor run
/v2/actor-runs/:runId/chargeCharge for events in the run of your pay-per-event Actor. The event you are charging for must be one of the configured events in your Actor. If the Actor is… - GETGet log of an Actor run
/v2/actor-runs/:runId/logRetrieves Actor run's logs. This endpoint is a shortcut for getting the run's log. Same as Get Actor build or run log endpoint.
Actor tasks
- GETGet list of Actor tasks
/v2/actor-tasksGets the complete list of tasks that a user has created or used. The response is a list of objects in which each object contains essential information about a… - POSTCreate Actor task
/v2/actor-tasksCreate a new task with settings specified by the object passed as JSON in the POST payload. The response is the full task object as returned by the Get Actor… - GETGet Actor task
/v2/actor-tasks/:actorTaskIdGet an object that contains all the details about a task. - PUTUpdate Actor task
/v2/actor-tasks/:actorTaskIdUpdate settings of a task using values specified by an object passed as JSON in the POST payload. If the object does not define a specific property, its value… - DELETEDelete Actor task
/v2/actor-tasks/:actorTaskIdDelete the task specified through the actorTaskId parameter. - GETGet Actor task input
/v2/actor-tasks/:actorTaskId/inputReturns the input of a given task. - PUTUpdate Actor task input
/v2/actor-tasks/:actorTaskId/inputUpdates the input of a task using values specified by an object passed as JSON in the PUT payload. If the object does not define a specific property, its… - GETGet list of Actor task's webhooks
/v2/actor-tasks/:actorTaskId/webhooksGets the list of webhooks of a specific Actor task. The response is a JSON with the list of objects, where each object contains basic information about a… - GETGet list of Actor task's runs
/v2/actor-tasks/:actorTaskId/runsGet a list of runs of a specific task. The response is a list of objects, where each object contains essential information about a single task run. The… - POSTRun Actor task
/v2/actor-tasks/:actorTaskId/runsRuns an Actor task and immediately returns without waiting for the run to finish. Optionally, you can override the Actor input configuration by passing a JSON… - GETRun Actor task synchronously and get key-value store record (GET)
/v2/actor-tasks/:actorTaskId/run-syncRuns an Actor task and synchronously returns a key-value store record. The response contains the record stored under the OUTPUT key in the run's default… - POSTRun Actor task synchronously and get key-value store record
/v2/actor-tasks/:actorTaskId/run-syncRuns an Actor task and synchronously returns a key-value store record. The response contains the record stored under the OUTPUT key in the run's default… - GETRun Actor task synchronously and get dataset items (GET)
/v2/actor-tasks/:actorTaskId/run-sync-get-dataset-itemsRun a specific task and return its dataset items. The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds otherwise the HTTP request fails… - POSTRun Actor task synchronously and get dataset items
/v2/actor-tasks/:actorTaskId/run-sync-get-dataset-itemsRuns an Actor task and synchronously returns its dataset items. The run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> seconds otherwise the HTTP… - GETGet last run of an Actor task
/v2/actor-tasks/:actorTaskId/runs/lastThis 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…
Storage/Datasets
- GETGet list of datasets
/v2/datasetsLists all of a user's datasets. The response is a JSON array of objects, where each object contains basic information about one dataset. By default, the… - POSTCreate dataset
/v2/datasetsCreates a dataset and returns its object. Keep in mind that data stored under unnamed dataset follows data retention period. It creates a dataset with the… - GETGet dataset
/v2/datasets/:datasetIdReturns dataset object for given dataset ID. This does not return dataset items, only information about the storage itself. To retrieve dataset items, use the… - PUTUpdate dataset
/v2/datasets/:datasetIdUpdates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the updated… - DELETEDelete dataset
/v2/datasets/:datasetIdDeletes a specific dataset. - GETGet dataset items
/v2/datasets/:datasetId/itemsReturns data stored in the dataset in a desired format. Response format The format of the response depends on <code>format</code> query parameter. The… - POSTStore items in dataset
/v2/datasets/:datasetId/itemsAppends an item or an array of items to the end of the dataset. The POST payload is a JSON object or a JSON array of objects to save into the dataset. If the… - HEADGet dataset items headers
/v2/datasets/:datasetId/itemsReturns only the HTTP headers for the dataset items endpoint, without the response body. This is useful to check pagination metadata or verify access without… - GETGet dataset statistics
/v2/datasets/:datasetId/statisticsReturns statistics for given dataset. Provides only field statistics.
Storage/Key-value stores
- GETGet list of key-value stores
/v2/key-value-storesGets the list of key-value stores owned by the user. The response is a list of objects, where each objects contains a basic information about a single… - POSTCreate key-value store
/v2/key-value-storesCreates a key-value store and returns its object. The response is the same object as returned by the Get key-value store endpoint. Keep in mind that data… - GETGet key-value store
/v2/key-value-stores/:storeIdGets an object that contains all the details about a specific key-value store. - PUTUpdate key-value store
/v2/key-value-stores/:storeIdUpdates a key-value store's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the… - DELETEDelete key-value store
/v2/key-value-stores/:storeIdDeletes a key-value store. - GETGet list of key-value store keys
/v2/key-value-stores/:storeId/keysReturns a list of objects describing keys of a given key-value store, as well as some information about the values (e.g. size). This endpoint is paginated… - GETDownload key-value store records
/v2/key-value-stores/:storeId/recordsDownloads all records from the key-value store as a ZIP archive. Each record is stored as a separate file in the archive, with the filename equal to the… - GETGet key-value store record
/v2/key-value-stores/:storeId/records/:recordKeyGets a value stored in the key-value store under a specific key. The response body has the same Content-Encoding header as it was set in Set key-value store… - PUTSet key-value store record
/v2/key-value-stores/:storeId/records/:recordKeyStores a value under a specific key to the key-value store. The value is passed as the PUT payload and it is stored with a MIME content type defined by the… - POSTSet key-value store record (POST)
/v2/key-value-stores/:storeId/records/:recordKeyStores a value under a specific key to the key-value store. This endpoint is an alias for the Set key-value store record endpoint and behaves identically. - DELETEDelete key-value store record
/v2/key-value-stores/:storeId/records/:recordKeyRemoves a record specified by a key from the key-value store. - HEADCheck if key-value store record exists
/v2/key-value-stores/:storeId/records/:recordKeyCheck if a value is stored in the key-value store under a specific key.
Storage/Request queues
- GETGet list of request queues
/v2/request-queuesLists all of a user's request queues. The response is a JSON array of objects, where each object contains basic information about one queue. By default, the… - POSTCreate request queue
/v2/request-queuesCreates a request queue and returns its object. Keep in mind that requests stored under unnamed queue follows data retention period. It creates a queue of… - GETGet request queue
/v2/request-queues/:queueIdReturns queue object for given queue ID. - PUTUpdate request queue
/v2/request-queues/:queueIdUpdates a request queue's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the… - DELETEDelete request queue
/v2/request-queues/:queueIdDeletes given queue. - POSTBatch add requests to request queue
/v2/request-queues/:queueId/requests/batchAdds requests to the queue in batch. The maximum requests in batch is limited to 25. The response contains an array of unprocessed and processed requests. If… - DELETEBatch delete requests from request queue
/v2/request-queues/:queueId/requests/batchBatch-deletes given requests from the queue. The number of requests in a batch is limited to 25. The response contains an array of unprocessed and processed…
Storage/Request queues/Requests
- GETList requests in request queue
/v2/request-queues/:queueId/requestsReturns a list of requests. This endpoint is paginated using cursor (pagination by exclusiveStartId is deprecated) and limit parameters. - POSTAdd request to request queue
/v2/request-queues/:queueId/requestsAdds request to the queue. Response contains ID of the request and info if request was already present in the queue or handled. If request with same uniqueKey… - GETGet request from request queue
/v2/request-queues/:queueId/requests/:requestIdReturns request from queue. - PUTUpdate request in request queue
/v2/request-queues/:queueId/requests/:requestIdUpdates a request in a queue. Mark request as handled by setting request.handledAt = new Date(). If handledAt is set, the request will be removed from head of… - DELETEDelete request from request queue
/v2/request-queues/:queueId/requests/:requestIdDeletes given request from queue.
Storage/Request queues/Requests locks
- POSTUnlock requests in request queue
/v2/request-queues/:queueId/requests/unlockUnlocks requests in the queue that are currently locked by the client. * If the client is within an Actor run, it unlocks all requests locked by that specific… - GETGet request queue head
/v2/request-queues/:queueId/headReturns given number of first requests from the queue. The response contains the hadMultipleClients boolean field which indicates that the queue was accessed… - POSTGet and lock request queue head
/v2/request-queues/:queueId/head/lock?lockSecs=60Returns the given number of first requests from the queue and locks them for the given time. If this endpoint locks the request, no other client or run will… - PUTProlong lock on request in request queue
/v2/request-queues/:queueId/requests/:requestId/lock?lockSecs=60Prolongs request lock. The request lock can be prolonged only by the client that has locked it using Get and lock head operation. The clientKey identifier is… - DELETEDelete lock on request in request queue
/v2/request-queues/:queueId/requests/:requestId/lockDeletes a request lock. The request lock can be deleted only by the client that has locked it using Get and lock head operation. The clientKey identifier is…
Webhooks/Webhooks
- GETGet list of webhooks
/v2/webhooksGets the list of webhooks that the user created. The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000… - POSTCreate webhook
/v2/webhooksCreates a new webhook with settings provided by the webhook object passed as JSON in the payload. The response is the created webhook object. To avoid… - GETGet webhook
/v2/webhooks/:webhookIdGets webhook object with all details. - PUTUpdate webhook
/v2/webhooks/:webhookIdUpdates a webhook using values specified by a webhook object passed as JSON in the POST payload. If the object does not define a specific property, its value… - DELETEDelete webhook
/v2/webhooks/:webhookIdDeletes a webhook. - POSTTest webhook
/v2/webhooks/:webhookId/testTests a webhook. Creates a webhook dispatch with a dummy payload. - GETGet list of webhook's dispatches
/v2/webhooks/:webhookId/dispatchesGets a given webhook's list of dispatches.
Webhooks/Webhook dispatches
- GETGet list of webhook dispatches
/v2/webhook-dispatchesGets the list of webhook dispatches that the user have. The endpoint supports pagination using the limit and offset parameters and it will not return more… - GETGet webhook dispatch
/v2/webhook-dispatches/:dispatchIdGets webhook dispatch object with all details.
Schedules
- GETGet list of schedules
/v2/schedulesGets the list of schedules that the user created. The endpoint supports pagination using the limit and offset parameters. It will not return more than 1000… - POSTCreate schedule
/v2/schedulesCreates a new schedule with settings provided by the schedule object passed as JSON in the payload. The response is the created schedule object. The request… - GETGet schedule
/v2/schedules/:scheduleIdGets the schedule object with all details. - PUTUpdate schedule
/v2/schedules/:scheduleIdUpdates a schedule using values specified by a schedule object passed as JSON in the POST payload. If the object does not define a specific property, its… - DELETEDelete schedule
/v2/schedules/:scheduleIdDeletes a schedule. - POSTInvoke schedule
/v2/schedules/:scheduleId/invokeImmediately runs all actions of the schedule, the same way as the Run now button in Apify Console. The invocation is recorded in the schedule log. It doesn't… - GETGet schedule log
/v2/schedules/:scheduleId/logGets the schedule log as a JSON array containing information about up to a 1000 invocations of the schedule.
Store
- GETGet list of Actors in Store
/v2/storeGets the list of public Actors in Apify Store. You can use search parameter to search Actors by string in title, name, description, username and readme. If…
Logs
- GETGet Actor build or run log
/v2/logs/:buildOrRunIdRetrieves logs for a specific Actor build or run.
Users
- GETGet public user data
/v2/users/:userIdReturns public information about a specific user account, similar to what can be seen on public profile pages (e.g. https://apify.com/apify). This operation… - GETGet private user data
/v2/users/meReturns information about the current user account, including both public and private information. The user account is identified by the provided… - GETGet git provider integrations
/v2/integrations/gitGets your connected git provider accounts (GitHub App, GitLab and Bitbucket), each with the workspaces you can create a repository in. Only authorized… - POSTCreate git repository
/v2/integrations/git/:providerId/create-repoCreates a repository through a connected git account and commits the initial files into it, either the given files or the files of an Actor template archive… - POSTRegister deployment key
/v2/integrations/git/:providerId/register-deployment-keyRegisters the Actor's deployment key (a read-only SSH key generated for every Actor) on a repository through a connected git account, so that Apify can clone…
Users/Usage
- GETGet user's monthly usage
/v2/users/me/usage/monthlyReturns a complete summary of your usage for the current monthly usage cycle, an overall sum, as well as a daily breakdown of usage. It is the same… - GETGet user's limits
/v2/users/me/limitsReturns a complete summary of your account's limits. It is the same information you will see on your account's Limits page. The returned data includes the… - PUTUpdate user's limits
/v2/users/me/limitsUpdates the account's limits manageable on your account's Limits page. Specifically the: maxMonthlyUsageUsd and dataRetentionDays limits (see request body… - GETGet user's monthly usage by ID
/v2/users/:userId/usage/monthlyReturns the same summary of monthly usage as Get user's monthly usage, for an account given by its ID or username. You can only access your own account, or… - GETGet user's limits by ID
/v2/users/:userId/limitsReturns the same summary of limits as Get user's limits, for an account given by its ID or username. You can only access your own account, or the organization… - PUTUpdate user's limits by ID
/v2/users/:userId/limitsUpdates the same limits as Update user's limits, for an account given by its ID or username. You can only access your own account, or the organization your…
Tools
- GETGet browser info
/v2/browser-infoReturns information about the HTTP request, including the client IP address, country code, request headers, and body length. This endpoint is designed for… - PUTGet browser info (PUT)
/v2/browser-infoReturns information about the HTTP request, including the client IP address, country code, request headers, and body length. This endpoint is designed for… - POSTGet browser info (POST)
/v2/browser-infoReturns information about the HTTP request, including the client IP address, country code, request headers, and body length. This endpoint is designed for… - DELETEGet browser info (DELETE)
/v2/browser-infoReturns information about the HTTP request, including the client IP address, country code, request headers, and body length. This endpoint is designed for…
Tools/Encoding
- POSTEncode and sign object
/v2/tools/encode-and-signEncodes and signs any JSON object. The encoded value includes a signature tied to the authenticated user's ID, which can later be verified using the… - POSTDecode and verify object
/v2/tools/decode-and-verifyDecodes and verifies an encoded value previously created by the encode-and-sign endpoint. Returns the original decoded object along with information about the…
Default dataset
- GETGet the default dataset of an Actor run
/v2/actor-runs/:runId/datasetReturns the default dataset associated with an Actor run. This endpoint is a shortcut for getting the run's defaultDatasetId and then using the Get dataset… - PUTUpdate the default dataset of an Actor run
/v2/actor-runs/:runId/datasetUpdates the default dataset associated with an Actor run. This endpoint is a shortcut for getting the run's defaultDatasetId and then using the Update dataset… - DELETEDelete the default dataset of an Actor run
/v2/actor-runs/:runId/datasetDeletes default dataset associated with an Actor run. This endpoint is a shortcut for getting the last run's defaultDatasetId and then using the Delete… - GETGet the default dataset items from an Actor run
/v2/actor-runs/:runId/dataset/itemsReturns data stored in the default dataset of the Actor run in the desired format. This endpoint is a shortcut that resolves the run's defaultDatasetId and… - POSTStore items in the default dataset of an Actor run
/v2/actor-runs/:runId/dataset/itemsAppends an item or an array of items to the end of the Actor run's default dataset. This endpoint is a shortcut that resolves the run's defaultDatasetId and… - GETGet the default dataset statistics for an Actor run
/v2/actor-runs/:runId/dataset/statisticsReturns statistics for the Actor run's default dataset. This endpoint is a shortcut that resolves the run's defaultDatasetId and proxies to the Get dataset…
Default key-value store
- GETGet the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-storeGets an object that contains all the details about the default key-value store. This endpoint is a shortcut for getting the run's defaultKeyValueStoreId and… - PUTUpdate the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-storeUpdates 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. This endpoint… - DELETEDelete the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-storeDelete the default key-value store. This endpoint is a shortcut for getting the run's defaultKeyValueStoreId and then using the Delete key-value store endpoint. - GETGet list of keys in the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-store/keysReturns a list of keys for the default key-value store of the Actor run. This endpoint is a shortcut for getting the run's defaultKeyValueStoreId and then… - GETDownload records from the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-store/recordsDownloads all records from the default key-value store of the Actor run as a ZIP archive. This endpoint is a shortcut for getting the run's… - GETGet record from the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-store/records/:recordKeyGets a value stored under a specific key in the default key-value store of the Actor run. This endpoint is a shortcut for getting the run's… - PUTSet record in the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-store/records/:recordKeyStores a value under a specific key in the default key-value store of the Actor run. This endpoint is a shortcut for getting the run's defaultKeyValueStoreId… - POSTSet record in the default key-value store of an Actor run (POST)
/v2/actor-runs/:runId/key-value-store/records/:recordKeyStores a value under a specific key in the default key-value store of the Actor run. This endpoint is a shortcut for getting the run's defaultKeyValueStoreId… - DELETEDelete record from the default key-value store of an Actor run
/v2/actor-runs/:runId/key-value-store/records/:recordKeyRemoves a record specified by a key from the default key-value store of the Actor run. This endpoint is a shortcut for getting the run's…
Default request queue
- GETGet the default request queue of an Actor run
/v2/actor-runs/:runId/request-queueReturns the default request queue associated with an Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the Get… - PUTUpdate the default request queue of an Actor run
/v2/actor-runs/:runId/request-queueUpdates the default request queue associated with an Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the… - DELETEDelete the default request queue of an Actor run
/v2/actor-runs/:runId/request-queueDeletes the default request queue associated with an Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the… - GETList requests in the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requestsReturns a list of requests from the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then… - POSTAdd request to the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requestsAdds a request to the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the Add… - POSTBatch add requests to the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/batchAdds requests to the default request queue of the Actor run in batch. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using… - DELETEBatch delete requests from the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/batchBatch-deletes requests from the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using… - POSTUnlock requests in the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/unlockUnlocks requests in the default request queue of the Actor run that are currently locked by the client. This endpoint is a shortcut for getting the run's… - GETGet request from the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/:requestIdReturns a request from the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the… - PUTUpdate request in the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/:requestIdUpdates a request in the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the… - DELETEDelete request from the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/:requestIdDeletes a request from the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the… - PUTProlong lock on request in the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/:requestId/lock?lockSecs=60Prolongs a request lock in the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using… - DELETEDelete lock on request in the default request queue of an Actor run
/v2/actor-runs/:runId/request-queue/requests/:requestId/lockDeletes a request lock in the default request queue of the Actor run. This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using… - GETGet the default request queue head for an Actor run
/v2/actor-runs/:runId/request-queue/headReturns the given number of first requests from the default request queue of the Actor run. This endpoint is a shortcut for getting the run's… - POSTGet and lock the default request queue head for an Actor run
/v2/actor-runs/:runId/request-queue/head/lock?lockSecs=60Returns the given number of first requests from the default request queue of the Actor run and locks them for the given time. This endpoint is a shortcut for…
Last Actor run's default dataset
- GETGet the default dataset of an Actor's last run
/v2/actors/:actorId/runs/last/datasetReturns the default dataset associated with the last Actor run. This endpoint is a shortcut for getting the last run's defaultDatasetId and then using the Get… - PUTUpdate the default dataset of an Actor's last run
/v2/actors/:actorId/runs/last/datasetUpdates the default dataset associated with the last Actor run. This endpoint is a shortcut for getting the last run's defaultDatasetId and then using the… - DELETEDelete the default dataset of an Actor's last run
/v2/actors/:actorId/runs/last/datasetDeletes the default dataset associated with the last Actor run. This endpoint is a shortcut for getting the last run's defaultDatasetId and then using the… - GETGet the default dataset items from an Actor's last run
/v2/actors/:actorId/runs/last/dataset/itemsReturns data stored in the default dataset of the last Actor run in the desired format. This endpoint is a shortcut that resolves the last run's… - POSTStore items in the default dataset of an Actor's last run
/v2/actors/:actorId/runs/last/dataset/itemsAppends an item or an array of items to the end of the last Actor run's default dataset. This endpoint is a shortcut that resolves the last run's… - GETGet the default dataset statistics for an Actor's last run
/v2/actors/:actorId/runs/last/dataset/statisticsReturns statistics for the last Actor run's default dataset. This endpoint is a shortcut that resolves the last run's defaultDatasetId and proxies to the Get…
Last Actor run's default key-value store
- GETGet the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-storeGets an object that contains all the details about the default key-value store associated with the last Actor run. This endpoint is a shortcut for getting the… - PUTUpdate the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-storeUpdates 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. This… - DELETEDelete the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-storeDeletes the last Actor run key-value store. This endpoint is a shortcut for getting the run's defaultKeyValueStoreId and then using the Delete key-value store… - GETGet list of keys in the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-store/keysReturns a list of keys for the default key-value store of the last Actor run. This endpoint is a shortcut for getting the last run's defaultKeyValueStoreId… - GETDownload records from the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-store/recordsDownloads all records from the default key-value store of the last Actor run as a ZIP archive. This endpoint is a shortcut for getting the last run's… - GETGet record from the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-store/records/:recordKeyGets a value stored under a specific key in the default key-value store of the last Actor run. This endpoint is a shortcut for getting the last run's… - PUTSet record in the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-store/records/:recordKeyStores a value under a specific key in the default key-value store of the last Actor run. This endpoint is a shortcut for getting the last run's… - POSTSet record in the default key-value store of an Actor's last run (POST)
/v2/actors/:actorId/runs/last/key-value-store/records/:recordKeyStores a value under a specific key in the default key-value store of the last Actor run. This endpoint is a shortcut for getting the last run's… - DELETEDelete record from the default key-value store of an Actor's last run
/v2/actors/:actorId/runs/last/key-value-store/records/:recordKeyRemoves a record specified by a key from the default key-value store of the last Actor run. This endpoint is a shortcut for getting the last run's…
Last Actor run's default request queue
- GETGet the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queueReturns the default request queue associated with the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then… - PUTUpdate the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queueUpdates the default request queue associated with the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then… - DELETEDelete the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queueDeletes the default request queue associated with the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then… - GETList requests in the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requestsReturns a list of requests from the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId… - POSTAdd request to the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requestsAdds a request to the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then using… - POSTBatch add requests to the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/batchAdds requests to the default request queue of the last Actor run in batch. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and… - DELETEBatch delete requests from the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/batchBatch-deletes requests from the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and… - POSTUnlock requests in the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/unlockUnlocks requests in the default request queue of the last Actor run that are currently locked by the client. This endpoint is a shortcut for getting the last… - GETGet request from the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/:requestIdReturns a request from the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then… - PUTUpdate request in the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/:requestIdUpdates a request in the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then… - DELETEDelete request from the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/:requestIdDeletes a request from the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and then… - PUTProlong lock on request in the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/:requestId/lock?lockSecs=60Prolongs a request lock in the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and… - DELETEDelete lock on request in the default request queue of an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/requests/:requestId/lockDeletes a request lock in the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's defaultRequestQueueId and… - GETGet the default request queue head for an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/headReturns the given number of first requests from the default request queue of the last Actor run. This endpoint is a shortcut for getting the last run's… - POSTGet and lock the default request queue head for an Actor's last run
/v2/actors/:actorId/runs/last/request-queue/head/lock?lockSecs=60Returns the given number of first requests from the default request queue of the last Actor run and locks them for the given time. This endpoint is a shortcut…
Last Actor run's log
- GETGet log of an Actor's last run
/v2/actors/:actorId/runs/last/logRetrieves last Actor run's logs. This endpoint is a shortcut for getting last Actor run's log. Same as Get Actor build or run log endpoint.
Last Actor run's abort
- POSTAbort Actor's last run
/v2/actors/:actorId/runs/last/abortAborts the last run of the specified Actor and returns an object that contains all the details about the run. This endpoint is a shortcut for Abort Actor run…
Last Actor run's metamorph
- POSTMetamorph Actor's last run
/v2/actors/:actorId/runs/last/metamorph?targetActorId=HDSasDasz78YcAPEBTransforms the last run of the specified Actor into a run of another Actor with a new input. This endpoint is a shortcut for Metamorph Actor run on the…
Last Actor run's reboot
- POSTReboot Actor's last run
/v2/actors/:actorId/runs/last/rebootReboots the last run of the specified Actor and returns an object that contains all the details about the rebooted run. This endpoint is a shortcut for Reboot…
Last Actor task run's log
- GETGet log of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/logRetrieves last Actor task run's logs. This endpoint is a shortcut for getting last Actor task run's log. Same as Get Actor build or run log endpoint.
Last Actor task run's abort
- POSTAbort last run of an Actor task
/v2/actor-tasks/:actorTaskId/runs/last/abortAborts the last run of the specified Actor task and returns an object that contains all the details about the run. This endpoint is a shortcut for Abort Actor…
Last Actor task run's metamorph
- POSTMetamorph last run of an Actor task
/v2/actor-tasks/:actorTaskId/runs/last/metamorph?targetActorId=HDSasDasz78YcAPEBTransforms the last run of the specified Actor task into a run of another Actor with a new input. This endpoint is a shortcut for Metamorph Actor run on the…
Last Actor task run's reboot
- POSTReboot last run of an Actor task
/v2/actor-tasks/:actorTaskId/runs/last/rebootReboots the last run of the specified Actor task and returns an object that contains all the details about the rebooted run. This endpoint is a shortcut for…
Last Actor task run's default dataset
- GETGet the default dataset of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/datasetReturns the default dataset associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultDatasetId and then… - PUTUpdate the default dataset of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/datasetUpdates the default dataset associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultDatasetId and then… - DELETEDelete the default dataset of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/datasetDeletes the default dataset associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultDatasetId and then… - GETGet the default dataset items from an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/dataset/itemsReturns data stored in the default dataset of the last Actor task run in the desired format. This endpoint is a shortcut that resolves the last task run's… - POSTStore items in the default dataset of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/dataset/itemsAppends an item or an array of items to the end of the last Actor task run's default dataset. This endpoint is a shortcut that resolves the last task run's… - GETGet the default dataset statistics for an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/dataset/statisticsReturns statistics for the last Actor task run's default dataset. This endpoint is a shortcut that resolves the last task run's defaultDatasetId and proxies…
Last Actor task run's default key-value store
- GETGet the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-storeGets an object that contains all the details about the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last… - PUTUpdate the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-storeUpdates the default key-value store associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's… - DELETEDelete the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-storeDeletes the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultKeyValueStoreId and then… - GETGet list of keys in the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-store/keysReturns a list of keys for the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's… - GETDownload records from the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-store/recordsDownloads all records from the default key-value store of the last Actor task run as a ZIP archive. This endpoint is a shortcut for getting the last task… - GETGet record from the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-store/records/:recordKeyGets a value stored under a specific key in the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task… - PUTSet record in the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-store/records/:recordKeyStores a value under a specific key in the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's… - POSTSet record in the default key-value store of an Actor task's last run (POST)
/v2/actor-tasks/:actorTaskId/runs/last/key-value-store/records/:recordKeyStores a value under a specific key in the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's… - DELETEDelete record from the default key-value store of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/key-value-store/records/:recordKeyRemoves a record specified by a key from the default key-value store of the last Actor task run. This endpoint is a shortcut for getting the last task run's…
Last Actor task run's default request queue
- GETGet the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queueReturns the default request queue associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId… - PUTUpdate the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queueUpdates the default request queue associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId… - DELETEDelete the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queueDeletes the default request queue associated with the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId… - GETGet the default request queue head for an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/headReturns the given number of first requests from the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task… - POSTGet and lock the default request queue head for an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/head/lock?lockSecs=60Returns the given number of first requests from the default request queue of the last Actor task run and locks them for the given time. This endpoint is a… - GETList requests in the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requestsReturns a list of requests from the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's… - POSTAdd request to the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requestsAdds a request to the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId and… - POSTBatch add requests to the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/batchAdds requests to the default request queue of the last Actor task run in batch. This endpoint is a shortcut for getting the last task run's… - DELETEBatch delete requests from the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/batchBatch-deletes requests from the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's… - POSTUnlock requests in the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/unlockUnlocks requests in the default request queue of the last Actor task run that are currently locked by the client. This endpoint is a shortcut for getting the… - GETGet request from the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/:requestIdReturns a request from the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId… - PUTUpdate request in the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/:requestIdUpdates a request in the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId… - DELETEDelete request from the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/:requestIdDeletes a request from the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's defaultRequestQueueId… - PUTProlong lock on request in the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/:requestId/lock?lockSecs=60Prolongs a request lock in the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's… - DELETEDelete lock on request in the default request queue of an Actor task's last run
/v2/actor-tasks/:actorTaskId/runs/last/request-queue/requests/:requestId/lockDeletes a request lock in the default request queue of the last Actor task run. This endpoint is a shortcut for getting the last task run's…
API details
- Base URL
https://api.apify.com- Authentication
- A bearer token in the Authorization header
An API key in the token query parameter - Operations
- 242 operations on 141 pathsGET 101POST 66DELETE 37PUT 36HEAD 2
5 marked deprecated - Main resources
- Actor Runtime API/Request queues 48Actor Runtime API/Key-value stores 29Actor Runtime API/Datasets 20Actor Runtime API/Actor runs 19Actor Runtime API/Actor tasks 18Actor tasks 15Default request queue 15Last Actor run's default request queue 15Last Actor task run's default request queue 15Actors/Actor versions 13
- Response formats
application/jsontext/plain*/*application/jsonl- Description format
- OpenAPI 3.1.2, API version
v2-2026-11-13T162342Z - Links
- OpenAPI document
- Listed from
- Apify's published OpenAPI description
How to test the Apify API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Apify API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get list of Actors” (GET /v2/actors), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Apify API?
The Apify API (version 2) provides programmatic access to the [Apify platform](https://docs.apify.com). The API is organized around… It is listed under Maps & location and has 242 endpoints.
Who publishes the Apify API?
It is listed from Apify's public API description (an OpenAPI document), not published by Apify on Swastik Codes. Anyone who controls apify.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Apify API?
Requests go to https://api.apify.com. Endpoint paths are added to this base URL.
How do I authenticate with the Apify API?
It accepts 2 methods: A bearer token in the Authorization header; an API key in the token query parameter.
How many endpoints does the Apify API have?
242 operations on 141 paths (101 GET, 66 POST, 37 DELETE, 36 PUT, 2 HEAD). The largest groups are Actor Runtime API/Request queues, Actor Runtime API/Key-value stores, Actor Runtime API/Datasets, Actor Runtime API/Actor runs.
Is forking the Apify API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.