{
"openapi": "3.1.2",
"info": {
"title": "Apify API",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"description": "\nThe Apify API (version 2) provides programmatic access to the [Apify\nplatform](https://docs.apify.com). The API is organized\naround [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer)\nHTTP endpoints.\n\nYou can download the complete OpenAPI schema of Apify API in the [YAML](http://docs.apify.com/api/openapi.yaml) or [JSON](http://docs.apify.com/api/openapi.json) formats. The source code is also available on [GitHub](https://github.com/apify/apify-docs/tree/master/apify-api/openapi).\n\nAll requests and responses (including errors) are encoded in\n[JSON](http://www.json.org/) format with UTF-8 encoding,\nwith a few exceptions that are explicitly described in the reference.\n\nTo access the API, we recommend using one of our API clients:\n\nStable API clients:\n- For [Node.js](https://nodejs.org/en/), we recommend the [`apify-client`](https://docs.apify.com/api/client/js) [NPM\npackage](https://www.npmjs.com/package/apify-client).\n- For [Python](https://www.python.org/), we recommend the [`apify-client`](https://docs.apify.com/api/client/python) [PyPI\npackage](https://pypi.org/project/apify-client/).\n\nExperimental API clients:\n- For [Java](https://www.java.com/), we recommend the `apify-client` [Maven central component](https://central.sonatype.com/artifact/com.apify/apify-client).\n- For [Rust](https://rust-lang.org/), we recommend the `apify-client` [crate](https://crates.io/crates/apify-client).\n- For [.NET](https://dotnet.microsoft.com/), we recommend the `apify-client` [Nuget package](https://www.nuget.org/packages/Apify.Client).\n- For [PHP](https://www.php.net/), we recommend the `apify-client` [Packagist package](https://packagist.org/packages/apify/apify-client).\n- For [Go](https://go.dev/), we recommend the `apify-client` [package](https://github.com/apify/apify-client-go/releases).\n\nThe clients' functions correspond to the API endpoints and have the same\nparameters. This simplifies development of apps that depend on the Apify\nplatform.\n\n:::note Important Request Details\n\n- `Content-Type` header: For requests with a JSON body, you must include the `Content-Type: application/json` header.\n\n- Method override: You can override the HTTP method using the `method` query parameter. This is useful for clients that can only send `GET` requests. For example, to call a `POST` endpoint, append `?method=POST` to the URL of your `GET` request.\n\n:::\n\n## Authentication\n\n\n**You can find your API token on the\n[Integrations](https://console.apify.com/settings/integrations) page in the\nApify Console.**\n\nTo use your token in a request, either:\n\n- Add the token to your request's `Authorization` header as `Bearer `.\nE.g., `Authorization: Bearer xxxxxxx`.\n[More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).\n(Recommended).\n- Add it as the `token` parameter to your request URL. (Less secure).\n\nUsing your token in the request header is more secure than using it as a URL\nparameter because URLs are often stored\nin browser history and server logs. This creates a chance for someone\nunauthorized to access your API token.\n\n**Never share your API token or password with untrusted parties!**\n\nFor more information, see our\n[integrations](https://docs.apify.com/platform/integrations) documentation.\n\n### Agentic payments\n\nAI agents can authenticate and pay for Actor runs without an Apify account\nusing agentic payments. Instead of an API token, the request carries a\npayment credential that both authorizes and pays for the call. Apify supports\nthe [x402 protocol](https://docs.apify.com/platform/integrations/x402)\n(`PAYMENT-SIGNATURE` header) and\n[Skyfire](https://docs.apify.com/platform/integrations/skyfire)\n(`skyfire-pay-id` header).\n\n## Basic usage\n\n\nTo run an Actor, send a POST request to the [Run\nActor](#/reference/actors/run-collection/run-actor) endpoint using either the\nActor ID code (e.g. `vKg4IjxZbEYTYeW8T`) or its name (e.g.\n`janedoe~my-actor`):\n\n`https://api.apify.com/v2/actors/[actor_id]/runs`\n\nIf the Actor is not runnable anonymously, you will receive a 401 or 403\n[response code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status).\nThis means you need to add your [secret API\ntoken](https://console.apify.com/account#/integrations) to the request's\n`Authorization` header ([recommended](#/introduction/authentication)) or as a\nURL query parameter `?token=[your_token]` (less secure).\n\nOptionally, you can include the query parameters described in the [Run\nActor](#/reference/actors/run-collection/run-actor) section to customize your\nrun.\n\nIf you're using Node.js, the best way to run an Actor is using the\n`Apify.call()` method from the [Apify\nSDK](https://sdk.apify.com/docs/api/apify#apifycallactid-input-options). It\nruns the Actor using the account you are currently logged into (determined\nby the [secret API token](https://console.apify.com/account#/integrations)).\nThe result is an [Actor run\nobject](https://sdk.apify.com/docs/typedefs/actor-run) and its output (if\nany).\n\nA typical workflow is as follows:\n\n1. Run an Actor or task using the [Run\nActor](#/reference/actors/run-collection/run-actor) or [Run\ntask](#/reference/actor-tasks/run-collection/run-task) API endpoints.\n2. Monitor the Actor run by periodically polling its progress using the [Get\nrun](#/reference/actor-runs/run-object-and-its-storages/get-run) API\nendpoint.\n3. Fetch the results from the [Get\nitems](#/reference/datasets/item-collection/get-items) API endpoint using the\n`defaultDatasetId`, which you receive in the Run request response.\nAdditional data may be stored in a key-value store. You can fetch them from\nthe [Get record](#/reference/key-value-stores/record/get-record) API endpoint\nusing the `defaultKeyValueStoreId` and the store's `key`.\n\n**Note**: Instead of periodic polling, you can also run your\n[Actor](#/reference/actors/run-actor-synchronously) or\n[task](#/reference/actor-tasks/runs-collection/run-task-synchronously)\nsynchronously. This will ensure that the request waits for 300 seconds (5\nminutes) for the run to finish and returns its output. If the run takes\nlonger, the request will time out and throw an error.\n\n## Legacy `/v2/acts/` URL prefix\n\n\nThe `/v2/acts/` prefix is deprecated but still fully functional, and \nsuch endpoint routes to the same handler as its `/v2/actors/...` counterpart. \nNew integrations should use the canonical /v2/actors/ prefix, \nbut existing clients keep working without changes.\n\n## Response structure\n\n\nMost API endpoints return a JSON object with the `data` property:\n\n```\n{\n \"data\": {\n ...\n }\n}\n```\n\nHowever, there are a few explicitly described exceptions, such as\n[Get dataset items](#/reference/datasets/item-collection/get-items) or\nKey-value store [Get record](#/reference/key-value-stores/record/get-record)\nAPI endpoints, which return data in other formats.\nIn case of an error, the response has the HTTP status code in the range of\n4xx or 5xx and the `data` property is replaced with `error`. For example:\n\n```\n{\n \"error\": {\n \"type\": \"record-not-found\",\n \"message\": \"Store was not found.\"\n }\n}\n```\n\nSee [Errors](#/introduction/errors) for more details.\n\n## Pagination\n\n\nAll API endpoints that return a list of records\n(e.g. [Get list of\nActors](#/reference/actors/actor-collection/get-list-of-actors))\nenforce pagination in order to limit the size of their responses.\n\nMost of these API endpoints are paginated using the `offset` and `limit`\nquery parameters.\nThe only exception is [Get list of\nkeys](#/reference/key-value-stores/key-collection/get-list-of-keys),\nwhich is paginated using the `exclusiveStartKey` query parameter.\n\n**IMPORTANT**: Each API endpoint that supports pagination enforces a certain\nmaximum value for the `limit` parameter,\nin order to reduce the load on Apify servers.\nThe maximum limit could change in future so you should never\nrely on a specific value and check the responses of these API endpoints.\n\n### Using offset\n\n\nMost API endpoints that return a list of records enable pagination using the\nfollowing query parameters:\n\n\n \n limit | \n Limits the response to contain a specific maximum number of items, e.g. limit=20. | \n
\n \n offset | \n Skips a number of items from the beginning of the list, e.g. offset=100. | \n
\n \n desc | \n \n By default, items are sorted in the order in which they were created or added to the list.\n This feature is useful when fetching all the items, because it ensures that items\n created after the client started the pagination will not be skipped.\n If you specify the desc=1 parameter, the items will be returned in the reverse order,\n i.e. from the newest to the oldest items.\n | \n
\n
\n\nThe response of these API endpoints is always a JSON object with the\nfollowing structure:\n\n```\n{\n \"data\": {\n \"total\": 2560,\n \"offset\": 250,\n \"limit\": 1000,\n \"count\": 1000,\n \"desc\": false,\n \"items\": [\n { 1st object },\n { 2nd object },\n ...\n { 1000th object }\n ]\n }\n}\n```\n\nThe following table describes the meaning of the response properties:\n\n\n \n | Property | \n Description | \n
\n \n total | \n The total number of items available in the list. | \n
\n \n offset | \n The number of items that were skipped at the start.\n This is equal to the offset query parameter if it was provided, otherwise it is 0. | \n
\n \n limit | \n The maximum number of items that can be returned in the HTTP response.\n It equals to the limit query parameter if it was provided or\n the maximum limit enforced for the particular API endpoint, whichever is smaller. | \n
\n \n count | \n The actual number of items returned in the HTTP response. | \n
\n \n desc | \n true if data were requested in descending order and false otherwise. | \n
\n \n items | \n An array of requested items. | \n
\n
\n\n### Using key\n\n\nThe records in the [key-value\nstore](https://docs.apify.com/platform/storage/key-value-store)\nare not ordered based on numerical indexes,\nbut rather by their keys in the UTF-8 binary order.\nTherefore the [Get list of\nkeys](#/reference/key-value-stores/key-collection/get-list-of-keys)\nAPI endpoint only supports pagination using the following query parameters:\n\n\n \n limit | \n Limits the response to contain a specific maximum number items, e.g. limit=20. | \n
\n \n exclusiveStartKey | \n Skips all records with keys up to the given key including the given key,\n in the UTF-8 binary order. | \n
\n
\n\nThe response of the API endpoint is always a JSON object with following\nstructure:\n\n```\n{\n \"data\": {\n \"limit\": 1000,\n \"isTruncated\": true,\n \"exclusiveStartKey\": \"my-key\",\n \"nextExclusiveStartKey\": \"some-other-key\",\n \"items\": [\n { 1st object },\n { 2nd object },\n ...\n { 1000th object }\n ]\n }\n}\n```\n\nThe following table describes the meaning of the response properties:\n\n\n \n | Property | \n Description | \n
\n \n limit | \n The maximum number of items that can be returned in the HTTP response.\n It equals to the limit query parameter if it was provided or\n the maximum limit enforced for the particular endpoint, whichever is smaller. | \n
\n \n isTruncated | \n true if there are more items left to be queried. Otherwise false. | \n
\n \n exclusiveStartKey | \n The last key that was skipped at the start. Is `null` for the first page. | \n
\n \n nextExclusiveStartKey | \n The value for the exclusiveStartKey parameter to query the next page of items. | \n
\n
\n\n## Errors\n\n\nThe Apify API uses common HTTP status codes: `2xx` range for success, `4xx`\nrange for errors caused by the caller\n(invalid requests) and `5xx` range for server errors (these are rare).\nEach error response contains a JSON object defining the `error` property,\nwhich is an object with\nthe `type` and `message` properties that contain the error code and a\nhuman-readable error description, respectively.\n\nFor example:\n\n```\n{\n \"error\": {\n \"type\": \"record-not-found\",\n \"message\": \"Store was not found.\"\n }\n}\n```\n\nHere is the table of the most common errors that can occur for many API\nendpoints:\n\n\n \n | status | \n type | \n message | \n
\n \n 400 | \n invalid-request | \n POST data must be a JSON object | \n
\n \n 400 | \n invalid-value | \n Invalid value provided: Comments required | \n
\n \n 400 | \n invalid-record-key | \n Record key contains invalid character | \n
\n \n 401 | \n token-not-provided | \n Authentication token was not provided | \n
\n \n 404 | \n record-not-found | \n Store was not found | \n
\n \n 429 | \n rate-limit-exceeded | \n You have exceeded the rate limit of ... requests per second | \n
\n \n 405 | \n method-not-allowed | \n This API endpoint can only be accessed using the following HTTP methods: OPTIONS, POST | \n
\n
\n\n## Rate limiting\n\n\nAll API endpoints limit the rate of requests in order to prevent overloading of Apify servers by misbehaving clients.\n\nThere are two kinds of rate limits - a global rate limit and a per-resource rate limit.\n\n### Global rate limit\n\n\nThe global rate limit is set to _250 000 requests per minute_.\nFor [authenticated](#/introduction/authentication) requests, it is counted per user,\nand for unauthenticated requests, it is counted per IP address.\n\n### Per-resource rate limit\n\n\nThe default per-resource rate limit is _60 requests per second per resource_, which in this context means a single Actor, a single Actor run, a single dataset, single key-value store etc.\nThe default rate limit is applied to every API endpoint except a few select ones, which have higher rate limits.\nEach API endpoint returns its rate limit in `X-RateLimit-Limit` header.\n\nThese endpoints have a rate limit of _200 requests per second per resource_:\n\n* CRUD ([get](#/reference/key-value-stores/record/get-record),\n [put](#/reference/key-value-stores/record/put-record),\n [delete](#/reference/key-value-stores/record/delete-record))\n operations on key-value store records\n\nThese endpoints have a rate limit of _400 requests per second per resource_:\n* [Run Actor](#/reference/actors/run-collection/run-actor)\n* [Run Actor task asynchronously](#/reference/actor-tasks/runs-collection/run-task-asynchronously)\n* [Run Actor task synchronously](#/reference/actor-tasks/runs-collection/run-task-synchronously)\n* [Metamorph Actor run](#/reference/actors/metamorph-run/metamorph-run)\n* [Push items](#/reference/datasets/item-collection/put-items) to dataset\n* CRUD\n ([add](#/reference/request-queues/request-collection/add-request),\n [get](#/reference/request-queues/request-collection/get-request),\n [update](#/reference/request-queues/request-collection/update-request),\n [delete](#/reference/request-queues/request-collection/delete-request))\n operations on requests in request queues\n\n### Rate limit exceeded errors\n\n\nIf the client is sending too many requests, the API endpoints respond with the HTTP status code `429 Too Many Requests`\nand the following body:\n\n```\n{\n \"error\": {\n \"type\": \"rate-limit-exceeded\",\n \"message\": \"You have exceeded the rate limit of ... requests per second\"\n }\n}\n```\n\n### Retrying rate-limited requests with exponential backoff\n\n\nIf the client receives the rate limit error, it should wait a certain period of time and then retry the request.\nIf the error happens again, the client should double the wait period and retry the request,\nand so on. This algorithm is known as _exponential backoff_\nand it can be described using the following pseudo-code:\n\n1. Define a variable `DELAY=500`\n2. Send the HTTP request to the API endpoint\n3. If the response has status code not equal to `429` then you are done. Otherwise:\n * Wait for a period of time chosen randomly from the interval `DELAY` to `2*DELAY` milliseconds\n * Double the future wait period by setting `DELAY = 2*DELAY`\n * Continue with step 2\n\nIf all requests sent by the client implement the above steps,\nthe client will automatically use the maximum available bandwidth for its requests.\n\nNote that the Apify API clients [for JavaScript](https://docs.apify.com/api/client/js)\nand [for Python](https://docs.apify.com/api/client/python)\nuse the exponential backoff algorithm transparently, so that you do not need to worry about it.\n\n## Referring to resources\n\n\nThere are three main ways to refer to a resource you're accessing via API.\n\n- the resource ID (e.g. `iKkPcIgVvwmztduf8`)\n- `username~resourcename` - when using this access method, you will need to\nuse your API token, and access will only work if you have the correct\npermissions.\n- `~resourcename` - for this, you need to use an API token, and the\n`resourcename` refers to a resource in the API token owner's account.\n",
"contact": {},
"version": "v2-2026-09-24T114302Z"
},
"servers": [
{
"url": "https://api.apify.com",
"variables": {}
}
],
"security": [
{
"httpBearer": []
},
{
"apiKey": []
}
],
"tags": [
{
"name": "Actors",
"x-displayName": "Actors",
"x-legacy-doc-urls": [
"#/reference/actors",
"#tag/Actors",
"#/reference/actors/actor-collection",
"#tag/ActorsActor-collection",
"#/reference/actors/actor-object",
"#tag/ActorsActor-object"
],
"description": "The API endpoints in this section allow you to manage [Apify Actors](https://docs.apify.com/platform/actors).\n\n## Identify an Actor\n\nFor API endpoints that require the `actorId` parameter, provide one of the following:\n- The Actor ID. It's part of the Actor's URL in Apify Console: `https://console.apify.com/actors/`. For example, `reGe1ST3OBgYZSsZJ`.\n- The username of the Actor owner plus the Actor name, separated by a tilde (`~`). For example, `apify~instagram-scraper`.\n"
},
{
"name": "Actors/Actor versions",
"x-displayName": "Actor versions",
"x-parent-tag-name": "Actors",
"x-legacy-doc-urls": [
"#/reference/actors/version-collection",
"#tag/ActorsVersion-collection",
"#/reference/actors/version-object",
"#tag/ActorsVersion-object",
"#/reference/actors/environment-variable-collection",
"#tag/ActorsEnvironment-variable-collection",
"#/reference/actors/environment-variable-object",
"#tag/ActorsEnvironment-variable-object"
],
"x-trait": "true",
"description": "The API endpoints in this section allow you to manage your Apify Actors versions.\n\n- The version object contains the source code of a specific version of an Actor.\n- The `sourceType` property indicates where the source code is hosted, and based\non its value the Version object has the following additional property:\n\n| **Value** | **Description** |\n|---|---|\n| `\"SOURCE_FILES\"` | Source code is comprised of multiple files specified in the `sourceFiles` array. Each item of the array is an object with the following fields:
- `name`: File path and name
- `format`: Format of the content, can be either `\"TEXT\"` or `\"BASE64\"`
- `content`: File content
Source files can be shown and edited in the Apify Console's Web IDE. |\n| `\"GIT_REPO\"` | Source code is cloned from a Git repository, whose URL is specified in the `gitRepoUrl` field. |\n| `\"TARBALL\"` | Source code is downloaded using a tarball or Zip file from a URL specified in the `tarballUrl` field. |\n|`\"GITHUB_GIST\"`| Source code is taken from a GitHub Gist, whose URL is specified in the `gitHubGistUrl` field. |\n\nFor more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code)\nin Actors documentation.\n"
},
{
"name": "Actors/Actor builds",
"x-displayName": "Actor builds",
"x-parent-tag-name": "Actors",
"x-legacy-doc-urls": [
"#/reference/actors/build-collection",
"#tag/ActorsBuild-collection",
"#/reference/actors/build-object",
"#tag/ActorsBuild-object",
"#tag/ActorsAbort-build"
],
"x-trait": "true",
"description": "The API endpoints in this section allow you to manage your Apify Actors builds.\n"
},
{
"name": "Actors/Actor runs",
"x-displayName": "Actor runs",
"x-parent-tag-name": "Actors",
"x-legacy-doc-urls": [
"#/reference/actors/run-collection",
"#tag/ActorsRun-collection",
"#tag/ActorsResurrect-run",
"#tag/ActorsMetamorph-run",
"#tag/ActorsAbort-run",
"#/reference/actors/run-object",
"#tag/ActorsRun-object",
"#/reference/actors/run-actor-synchronously",
"#tag/ActorsRun-actor-synchronously",
"#/reference/actors/run-actor-synchronously-and-get-dataset-items",
"#tag/ActorsRun-Actor-synchronously-and-get-dataset-items",
"#/reference/actors/last-run-object-and-its-storages",
"#tag/ActorsLast-run-object-and-its-storages"
],
"description": "The API endpoints in this section allow you to manage your Apify Actors runs.\n\nSome API endpoints return run objects. If a run object includes usage costs in dollars, note that these values are calculated based on your effective unit pricing at the time of the query. As a result, the dollar amounts should be treated as informational only and not as exact figures.\n\nFor completed runs, aggregated fields such as `stats` or dollar usage totals are eventually consistent and update within a few seconds. For values that must match finalized totals, wait about 10 seconds after the run completed, then fetch the run again.\n\nFor more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).\n",
"x-trait": "true"
},
{
"name": "Actors/Webhook collection",
"x-displayName": "Webhook collections",
"x-parent-tag-name": "Actors",
"x-legacy-doc-urls": [
"#/reference/actors/webhook-collection",
"#tag/ActorsWebhook-collection"
],
"description": "The API endpoint in this section allows you to get a list of webhooks of a specific Actor.\n",
"x-trait": "true"
},
{
"name": "Actor builds",
"x-displayName": "Manage Actor builds",
"x-legacy-doc-urls": [
"#/reference/actor-builds",
"#tag/Actor-builds",
"#/reference/actor-builds/build-collection",
"#tag/Actor-buildsBuild-collection",
"#/reference/actor-builds/build-object",
"#tag/Actor-buildsBuild-object",
"#tag/Actor-buildsDelete-build",
"#tag/Actor-buildsAbort-build",
"#/reference/actor-builds/build-log",
"#tag/Actor-buildsBuild-log"
],
"description": "The API endpoints described in this section enable you to manage, and delete Apify Actor builds.\n\nNote that if any returned build object contains usage in dollars, your effective\nunit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be\nused only for informative purposes.\n\nYou can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).\n"
},
{
"name": "Actor runs",
"x-displayName": "Manage Actor runs",
"x-legacy-doc-urls": [
"#/reference/actor-runs",
"#tag/Actor-runs",
"#/reference/actor-runs/run-collection",
"#tag/Actor-runsRun-collection",
"#/reference/actor-runs/run-object-and-its-storages",
"#tag/Actor-runsRun-object-and-its-storages"
],
"description": "The API endpoints described in this section enable you to manage, and delete Apify Actor runs.\n\nIf any returned run object contains usage in dollars, your effective unit pricing at the time of query\nhas been used for computation of this dollar equivalent, and hence it should be used only for informative purposes.\n\nFor completed runs, aggregated fields such as `stats` or dollar usage totals are eventually consistent and update within a few seconds. For values that must match finalized totals, wait about 10 seconds after the run completed, then fetch the run again.\n\nYou can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).\n"
},
{
"name": "Actor tasks",
"x-displayName": "Manage Actor tasks",
"x-legacy-doc-urls": [
"#/reference/actor-tasks",
"#tag/Actor-tasks",
"#/reference/actor-tasks/task-collection",
"#tag/Actor-tasksTask-collection",
"#/reference/actor-tasks/task-object",
"#tag/Actor-tasksTask-object",
"#/reference/actor-tasks/task-input-object",
"#tag/Actor-tasksTask-input-object",
"#/reference/actor-tasks/webhook-collection",
"#tag/Actor-tasksWebhook-collection",
"#/reference/actor-tasks/run-collection",
"#tag/Actor-tasksRun-collection",
"#/reference/actor-tasks/run-task-synchronously",
"#tag/Actor-tasksRun-task-synchronously",
"#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items",
"#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items",
"#/reference/actor-tasks/last-run-object-and-its-storages",
"#tag/Actor-tasksLast-run-object-and-its-storages"
],
"description": "The API endpoints described in this section enable you to create, manage, delete, and run Apify Actor tasks.\nFor more information, see the [Actor tasks documentation](https://docs.apify.com/platform/actors/running/tasks).\n\n:::note\n\nFor all the API endpoints that accept the `actorTaskId` parameter to\nspecify a task, you can pass either the task ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated\nusername of the task's owner and the task's name (e.g. `janedoe~my-task`).\n\n:::\n\nSome of the API endpoints return run objects. If any such run object\ncontains usage in dollars, your effective unit pricing at the time of query\nhas been used for computation of this dollar equivalent, and hence it should be\nused only for informative purposes.\n\nYou can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage).\n"
},
{
"name": "Storage",
"x-displayName": "",
"description": "Storage-related API endpoints for managing datasets, key-value stores, and request queues."
},
{
"name": "Storage/Datasets",
"x-displayName": "Datasets",
"x-parent-tag-name": "Storage",
"x-legacy-doc-urls": [
"#/reference/datasets",
"#tag/Datasets",
"#/reference/datasets/dataset-collection",
"#tag/DatasetsDataset-collection",
"#/reference/datasets/dataset",
"#tag/DatasetsDataset",
"#/reference/datasets/item-collection",
"#tag/DatasetsItem-collection"
],
"description": "This section describes API endpoints to manage Datasets.\n\nDataset is a storage for structured data, where each record stored has the same attributes,\nsuch as online store products or real estate offers. You can imagine it as a table,\nwhere each object is a row and its attributes are columns. Dataset is an append-only\nstorage - you can only add new records to it but you cannot modify or remove existing\nrecords. Typically it is used to store crawling results.\n\nFor more information, see the [Datasets documentation](https://docs.apify.com/platform/storage/dataset).\n\n:::note\n\nSome of the endpoints do not require the authentication token, the calls\nare authenticated using the hard-to-guess ID of the dataset.\n\n:::\n",
"x-trait": "true"
},
{
"name": "Storage/Key-value stores",
"x-displayName": "Key-value stores",
"x-parent-tag-name": "Storage",
"x-legacy-doc-urls": [
"#/reference/key-value-stores/key-collection",
"#tag/Key-value-storesKey-collection",
"#/reference/key-value-stores/store-collection",
"#tag/Key-value-storesStore-collection",
"#/reference/key-value-stores/store-object",
"#tag/Key-value-storesStore-object",
"#/reference/key-value-stores/record",
"#tag/Key-value-storesRecord",
"#/reference/key-value-stores",
"#tag/Key-value-stores"
],
"description": "This section describes API endpoints to manage Key-value stores.\nKey-value store is a simple storage for saving and reading data records or files.\nEach data record is represented by a unique key and associated with a MIME content type.\nKey-value stores are ideal for saving screenshots, Actor inputs and outputs, web pages,\nPDFs or to persist the state of crawlers.\n\nFor more information, see the [Key-value store documentation](https://docs.apify.com/platform/storage/key-value-store).\n\n:::note\n\nSome of the endpoints do not require the authentication token, the calls\nare authenticated using a hard-to-guess ID of the key-value store.\n\n:::\n",
"x-trait": "true"
},
{
"name": "Storage/Request queues",
"x-displayName": "Request queues",
"x-parent-tag-name": "Storage",
"x-legacy-doc-urls": [
"#/reference/request-queues",
"#tag/Request-queues",
"#/reference/request-queues/queue-collection",
"#tag/Request-queuesQueue-collection",
"#/reference/request-queues/queue",
"#tag/Request-queuesQueue",
"#/reference/request-queues/batch-request-operations",
"#tag/Request-queuesBatch-request-operations"
],
"description": "This section describes API endpoints to create, manage, and delete request queues.\n\nRequest queue is a storage for a queue of HTTP URLs to crawl, which is typically\nused for deep crawling of websites where you\nstart with several URLs and then recursively follow links to other pages.\nThe storage supports both breadth-first and depth-first crawling orders.\n\nFor more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue).\n\n:::note\n\nSome of the endpoints do not require the authentication token, the calls\nare authenticated using the hard-to-guess ID of the queue.\n\n:::\n"
},
{
"name": "Storage/Request queues/Requests",
"x-displayName": "Requests",
"x-parent-tag-name": "Storage",
"x-legacy-doc-urls": [
"#/reference/request-queues/request-collection",
"#tag/Request-queuesRequest-collection",
"#/reference/request-queues/request",
"#tag/Request-queuesRequest"
],
"description": "This section describes API endpoints to create, manage, and delete requests within request queues.\n\nRequest queue is a storage for a queue of HTTP URLs to crawl, which is typically\nused for deep crawling of websites where you\nstart with several URLs and then recursively follow links to other pages.\nThe storage supports both breadth-first and depth-first crawling orders.\n\nFor more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue).\n\n:::note\n\nSome of the endpoints do not require the authentication token, the calls\nare authenticated using the hard-to-guess ID of the queue.\n\n:::\n"
},
{
"name": "Storage/Request queues/Requests locks",
"x-displayName": "Requests locks",
"x-parent-tag-name": "Storage",
"x-legacy-doc-urls": [
"#/reference/request-queues/request-lock",
"#tag/Request-queuesRequest-lock",
"#/reference/request-queues/queue-head",
"#tag/Request-queuesQueue-head",
"#/reference/request-queues/queue-head-with-locks",
"#tag/Request-queuesQueue-head-with-locks"
],
"description": "This section describes API endpoints to create, manage, and delete request locks within request queues.\n\nRequest queue is a storage for a queue of HTTP URLs to crawl, which is typically\nused for deep crawling of websites where you\nstart with several URLs and then recursively follow links to other pages.\nThe storage supports both breadth-first and depth-first crawling orders.\n\nFor more information, see the [Request queue documentation](https://docs.apify.com/platform/storage/request-queue).\n\n:::note\n\nSome of the endpoints do not require the authentication token, the calls\nare authenticated using the hard-to-guess ID of the queue.\n\n:::\n"
},
{
"name": "Webhooks",
"x-displayName": "",
"description": "Webhook-related API endpoints for configuring automated notifications."
},
{
"name": "Webhooks/Webhooks",
"x-displayName": "Webhooks",
"x-parent-tag-name": "Webhooks",
"x-legacy-doc-urls": [
"#/reference/webhooks",
"#tag/Webhooks",
"#/reference/webhooks/webhook-collection",
"#tag/WebhooksWebhook-collection",
"#/reference/webhooks/webhook-object",
"#tag/WebhooksWebhook-object",
"#/reference/webhooks/webhook-test",
"#tag/WebhooksWebhook-test",
"#/reference/webhooks/dispatches-collection",
"#tag/WebhooksDispatches-collection"
],
"description": "This section describes API endpoints to manage webhooks.\n\nWebhooks provide an easy and reliable way to configure the Apify platform\nto carry out an action (e.g. a HTTP request to another service) when a certain\nsystem event occurs.\nFor example, you can use webhooks to start another Actor when an Actor run finishes\nor fails.\n\nFor more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).\n"
},
{
"name": "Webhooks/Webhook dispatches",
"x-displayName": "Webhook dispatches",
"x-parent-tag-name": "Webhooks",
"x-legacy-doc-urls": [
"#/reference/webhook-dispatches",
"#tag/Webhook-dispatches",
"#/reference/webhook-dispatches/webhook-dispatches-collection",
"#tag/Webhook-dispatchesWebhook-dispatches-collection",
"#/reference/webhook-dispatches/webhook-dispatch-object",
"#tag/Webhook-dispatchesWebhook-dispatch-object"
],
"description": "This section describes API endpoints to get webhook dispatches."
},
{
"name": "Schedules",
"x-displayName": "Manage schedules",
"x-legacy-doc-urls": [
"#/reference/schedules",
"#tag/Schedules",
"#/reference/schedules/schedules-collection",
"#tag/SchedulesSchedules-collection",
"#/reference/schedules/schedule-object",
"#tag/SchedulesSchedule-object",
"#/reference/schedules/schedule-log",
"#tag/SchedulesSchedule-log"
],
"description": "This section describes API endpoints for managing schedules.\n\nSchedules are used to automatically start your Actors at certain times. Each schedule\ncan be associated with a number of Actors and Actor tasks. It is also possible\nto override the settings of each Actor (task) similarly to when invoking the Actor\n(task) using the API.\nFor more information, see [Schedules documentation](https://docs.apify.com/platform/schedules).\n\nEach schedule is assigned actions for it to perform. Actions can be of two types\n- `RUN_ACTOR` and `RUN_ACTOR_TASK`.\n\nFor details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint.\n",
"x-trait": "true"
},
{
"name": "Store",
"x-displayName": "Get data from Apify Store",
"x-legacy-doc-urls": [
"#/reference/store",
"#tag/Store",
"#/reference/store/store-actors-collection",
"#tag/StoreStore-Actors-collection"
],
"description": "[Apify Store](https://apify.com/store) is home to thousands of public Actors available\nto the Apify community.\nThe API endpoints described in this section are used to retrieve these Actors.\n\n:::note\n\nThese endpoints do not require the authentication token.\n\n:::\n",
"x-trait": true
},
{
"name": "Logs",
"x-displayName": "Get build and run logs",
"x-legacy-doc-urls": [
"#/reference/logs",
"#tag/Logs",
"#/reference/logs/log",
"#tag/LogsLog"
],
"description": "The API endpoints described in this section are used the download the logs\ngenerated by Actor builds and runs. Note that only the trailing 5M characters\nof the log are stored, the rest is discarded.\n\n:::note\n\nNote that the endpoints do not require the authentication token, the calls\nare authenticated using a hard-to-guess ID of the Actor build or run.\n\n:::\n",
"x-trait": true
},
{
"name": "Users",
"x-displayName": "Get user data",
"x-legacy-doc-urls": [
"#/reference/users",
"#tag/Users",
"#/reference/users/public-data",
"#tag/UsersPublic-data",
"#/reference/users/private-data",
"#tag/UsersPrivate-data",
"#/reference/users/monthly-usage",
"#tag/UsersMonthly-usage",
"#/reference/users/account-and-usage-limits",
"#tag/UsersAccount-and-usage-limits"
],
"description": "The API endpoints described in this section return information about\nuser accounts.\n",
"x-trait": true
},
{
"name": "Users/Usage",
"x-displayName": "Manage usage and limits",
"x-parent-tag-name": "Users",
"description": "The API endpoints described in this section return your account's usage for the\ncurrent monthly cycle and let you view and update your account limits.\n\nFor details, see the [Limits](https://docs.apify.com/account/limits).\n"
},
{
"name": "Tools",
"x-displayName": "Test proxy",
"description": "The API endpoints described in this section let you test your proxy connection.\n\nFor details, see the [Apify Proxy](https://docs.apify.com/platform/proxy).\n"
},
{
"name": "Tools/Encoding",
"x-displayName": "Sign and verify objects",
"description": "The API endpoints described in this section provide utility tools for encoding and decoding data.\n"
},
{
"name": "Default dataset",
"x-displayName": "Default dataset",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor run's default dataset without the need to resolve the dataset ID first.\n\nSubset of functionality described in: [Datasets](/api/v2/storage-datasets)\n"
},
{
"name": "Default key-value store",
"x-displayName": "Default key-value store",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor run's default key-value store without the need to resolve the key-value store ID first.\n\nSubset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores)\n"
},
{
"name": "Default request queue",
"x-displayName": "Default request queue",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor run's default request queue without the need to resolve the request queue ID first.\n\nSubset of functionality described in: [Request queues](/api/v2/storage-request-queues)\n"
},
{
"name": "Last Actor run's default dataset",
"x-displayName": "Last Actor run's default dataset",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default dataset without the need to resolve the dataset ID first.\n\nSubset of functionality described in: [Datasets](/api/v2/storage-datasets)\n"
},
{
"name": "Last Actor run's default key-value store",
"x-displayName": "Last Actor run's default key-value store",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default key-value store without the need to resolve the key-value store ID first.\n\nSubset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores)\n"
},
{
"name": "Last Actor run's default request queue",
"x-displayName": "Last Actor run's default request queue",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor's last run's default request queue without the need to resolve the request queue ID first.\n\nSubset of functionality described in: [Request queues](/api/v2/storage-request-queues)\n"
},
{
"name": "Last Actor run's log",
"x-displayName": "Last Actor run's log",
"description": "The API endpoint described in this section is convenience endpoint that provides access to last Actor run's log.\n\nSame as of functionality described in: [Logs](/api/v2/logs)\n"
},
{
"name": "Last Actor run's abort",
"x-displayName": "Last Actor run's abort",
"description": "The API endpoint described in this section is a convenience endpoint that aborts the Actor's last run.\n\nSame as of functionality described in: [Abort run](/api/v2/actor-run-abort-post)\n"
},
{
"name": "Last Actor run's metamorph",
"x-displayName": "Last Actor run's metamorph",
"description": "The API endpoint described in this section is a convenience endpoint that metamorphs the Actor's last run into a run of another Actor.\n\nSame as of functionality described in: [Metamorph run](/api/v2/actor-run-metamorph-post)\n"
},
{
"name": "Last Actor run's reboot",
"x-displayName": "Last Actor run's reboot",
"description": "The API endpoint described in this section is a convenience endpoint that reboots the Actor's last run.\n\nSame as of functionality described in: [Reboot run](/api/v2/actor-run-reboot-post)\n"
},
{
"name": "Last Actor task run's log",
"x-displayName": "Last Actor task run's log",
"description": "The API endpoint described in this section is convenience endpoint that provides access to last Actor task run's log.\n\nSame as of functionality described in: [Logs](/api/v2/logs)\n"
},
{
"name": "Last Actor task run's abort",
"x-displayName": "Last Actor task run's abort",
"description": "The API endpoint described in this section is a convenience endpoint that aborts the Actor task's last run.\n\nSame as of functionality described in: [Abort run](/api/v2/actor-run-abort-post)\n"
},
{
"name": "Last Actor task run's metamorph",
"x-displayName": "Last Actor task run's metamorph",
"description": "The API endpoint described in this section is a convenience endpoint that metamorphs the Actor task's last run into a run of another Actor.\n\nSame as of functionality described in: [Metamorph run](/api/v2/actor-run-metamorph-post)\n"
},
{
"name": "Last Actor task run's reboot",
"x-displayName": "Last Actor task run's reboot",
"description": "The API endpoint described in this section is a convenience endpoint that reboots the Actor task's last run.\n\nSame as of functionality described in: [Reboot run](/api/v2/actor-run-reboot-post)\n"
},
{
"name": "Last Actor task run's default dataset",
"x-displayName": "Last Actor task run's default dataset",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default dataset without the need to resolve the dataset ID first.\n\nSubset of functionality described in: [Datasets](/api/v2/storage-datasets)\n"
},
{
"name": "Last Actor task run's default key-value store",
"x-displayName": "Last Actor task run's default key-value store",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default key-value store without the need to resolve the key-value store ID first.\n\nSubset of functionality described in: [Key-value stores](/api/v2/storage-key-value-stores)\n"
},
{
"name": "Last Actor task run's default request queue",
"x-displayName": "Last Actor task run's default request queue",
"description": "The API endpoints described in this section are convenience endpoints that provide access to Actor task's last run's default request queue without the need to resolve the request queue ID first.\n\nSubset of functionality described in: [Request queues](/api/v2/storage-request-queues)\n"
}
],
"paths": {
"/v2/actors": {
"get": {
"tags": [
"Actors"
],
"summary": "Get list of Actors",
"description": "Gets the list of all Actors that the user created or used. The response is a\nlist of objects, where each object contains a basic information about a single Actor.\n\nTo only get Actors created by the user, add the `my=1` query parameter.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\n\nBy default, the records are sorted by the `createdAt` field in ascending\norder, therefore you can use pagination to incrementally fetch all Actors while new\nones are still being created. To sort the records in descending order, use the `desc=1` parameter.\n\nYou can also sort by your last run by using the `sortBy=stats.lastRunStartedAt` query parameter.\nIn this case, descending order means the most recently run Actor appears first.\n",
"operationId": "actors_get",
"parameters": [
{
"name": "my",
"in": "query",
"description": "If `true` or `1` then the returned list only contains Actors owned by the user. The default value is `false`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort the records by. The default is `createdAt`. You can also use `stats.lastRunStartedAt` to sort\nby the most recently ran Actors.\n",
"schema": {
"type": "string",
"enum": [
"createdAt",
"stats.lastRunStartedAt"
],
"example": "createdAt"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfActorsResponse"
},
"example": {
"data": {
"total": 2,
"count": 2,
"offset": 0,
"limit": 1000,
"desc": false,
"items": [
{
"id": "br9CKmk457",
"createdAt": "2019-10-29T07:34:24.202Z",
"modifiedAt": "2019-10-30T07:34:24.202Z",
"name": "MyAct",
"username": "janedoe"
},
{
"id": "ksiEKo23pz",
"createdAt": "2019-11-30T07:34:24.202Z",
"modifiedAt": "2019-12-12T07:34:24.202Z",
"name": "MySecondAct",
"username": "janedoe"
}
]
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors",
"https://docs.apify.com/api/v2#/reference/actors/get-list-of-actors",
"https://docs.apify.com/api/v2#tag/ActorsActor-collection/operation/acts_get"
],
"x-js-parent": "ActorCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorCollectionClient#list",
"x-py-parent": "ActorCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#list"
},
"post": {
"tags": [
"Actors"
],
"summary": "Create Actor",
"description": "Creates an Actor with the settings specified in an `Actor` object passed as\nJSON in the POST payload.\n\nReturns the created `Actor` object.\n\nIn the HTTP request, set the `Content-Type` header to `application/json`.\n\n### Define a source code version\n\nAn Actor must specify at least one version of the source code.\nFor details, see [Actor versions](/api/v2/actors-actor-versions).\n\n### Publish an Actor\n\nTo make your Actor [public](https://docs.apify.com/platform/actors/publishing),\nuse the [Update Actor](/api/v2/actor-put) endpoint.\n",
"operationId": "actors_post",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateActorRequest"
},
"example": {
"name": "MyActor",
"description": "My favourite Actor!",
"title": "My Actor",
"isPublic": false,
"seoTitle": "My Actor",
"seoDescription": "My Actor is the best",
"versions": [
{
"versionNumber": "0.0",
"sourceType": "SOURCE_FILES",
"envVars": [
{
"name": "DOMAIN",
"value": "http://example.com",
"isSecret": false
},
{
"name": "SECRET_PASSWORD",
"value": "MyTopSecretPassword123",
"isSecret": true
}
],
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
}
],
"categories": [],
"defaultRunOptions": {
"build": "latest",
"timeoutSecs": 3600,
"memoryMbytes": 2048,
"restartOnError": false
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActorResponse"
},
"example": {
"data": {
"id": "zdc3Pyhyz3m8vjDeM",
"userId": "wRsJZtadYvn4mBZmm",
"name": "instagram-scraper",
"username": "jane35",
"description": "This scraper extracts posts and comments from Instagram.",
"isPublic": false,
"createdAt": "2019-07-08T11:27:57.401Z",
"modifiedAt": "2019-07-08T14:01:05.546Z",
"taggedBuilds": {},
"stats": {
"totalBuilds": 9,
"totalRuns": 16,
"totalUsers": 6,
"totalUsers7Days": 2,
"totalUsers30Days": 6,
"totalUsers90Days": 6,
"totalMetamorphs": 2
},
"versions": [
{
"versionNumber": "0.0",
"envVars": null,
"sourceType": "SOURCE_FILES",
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
}
],
"defaultRunOptions": {
"build": "latest",
"timeoutSecs": 3600,
"memoryMbytes": 2048,
"restartOnError": false
},
"exampleRunInput": {
"body": "{ \"helloWorld\": 123 }",
"contentType": "application/json; charset=utf-8"
},
"categories": [],
"isDeprecated": false,
"title": "My Actor",
"notice": "NONE",
"isCritical": false,
"isGeneric": false,
"hasNoDataset": false,
"isSourceCodeHidden": true,
"standbyUrl": null,
"actorPermissionLevel": "LIMITED_PERMISSIONS"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor",
"https://docs.apify.com/api/v2#/reference/actors/create-actor",
"https://docs.apify.com/api/v2#tag/ActorsActor-collection/operation/acts_post"
],
"x-js-parent": "ActorCollectionClient",
"x-js-name": "create",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorCollectionClient#create",
"x-py-parent": "ActorCollectionClientAsync",
"x-py-name": "create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#create"
}
},
"/v2/actors/{actorId}": {
"get": {
"tags": [
"Actors"
],
"summary": "Get Actor",
"description": "Gets an object that contains all the details about the Actor with the specified ID.",
"operationId": "actor_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActorResponse"
},
"example": {
"data": {
"id": "zdc3Pyhyz3m8vjDeM",
"userId": "wRsJZtadYvn4mBZmm",
"name": "instagram-scraper",
"username": "jane35",
"description": "Extract data from Instagram.",
"isPublic": false,
"createdAt": "2019-07-08T11:27:57.401Z",
"modifiedAt": "2019-07-08T14:01:05.546Z",
"stats": {
"totalBuilds": 9,
"totalRuns": 16,
"totalUsers": 6,
"totalUsers7Days": 2,
"totalUsers30Days": 6,
"totalUsers90Days": 6,
"totalMetamorphs": 2,
"lastRunStartedAt": "2019-07-08T14:01:05.546Z"
},
"versions": [
{
"versionNumber": "0.1",
"envVars": null,
"sourceType": "SOURCE_FILES",
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
},
{
"versionNumber": "0.2",
"sourceType": "GIT_REPO",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"gitRepoUrl": "https://github.com/jane35/my-actor"
},
{
"versionNumber": "0.3",
"sourceType": "TARBALL",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip"
},
{
"versionNumber": "0.4",
"sourceType": "GITHUB_GIST",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89"
}
],
"defaultRunOptions": {
"build": "latest",
"timeoutSecs": 3600,
"memoryMbytes": 2048,
"restartOnError": false
},
"exampleRunInput": {
"body": "{ \"helloWorld\": 123 }",
"contentType": "application/json; charset=utf-8"
},
"isDeprecated": false,
"deploymentKey": "ssh-rsa AAAA ...",
"title": "Instagram Scraper",
"taggedBuilds": {
"latest": {
"buildId": "z2EryhbfhgSyqj6Hn",
"buildNumber": "0.0.2",
"finishedAt": "2019-06-10T11:15:49.286Z"
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor",
"https://docs.apify.com/api/v2#/reference/actors/get-actor",
"https://docs.apify.com/api/v2#tag/ActorsActor-object/operation/act_get"
],
"x-js-parent": "ActorClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#get",
"x-py-parent": "ActorClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#get"
},
"put": {
"tags": [
"Actors"
],
"summary": "Update Actor",
"description": "Updates an Actor's settings with the values specified in an `Actor` object\npassed as JSON in the POST payload. Only the fields specified in the request body are updated.\n\nReturns the full `Actor` object, the same as the\n[Get Actor](/api/v2/actor-get) endpoint.\n\nIn the HTTP request, set the `Content-Type` header to `application/json`.\n\n### Authentication\n\nTo provide the authentication token, we recommend using the request's\n`Authorization` header, rather than the URL. For details,\nsee [Authentication](/api/v2/getting-started#authentication).\n\n### Make an Actor public\n\nTo make your Actor [public](https://docs.apify.com/platform/actors/publishing):\n- Set `isPublic` to `true`.\n- Provide `title` and `categories`. For reference, see [constants from the `apify-shared-js`\npackage](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471)\n\n### Update build tags\n\nTo change tags assigned to Actor builds, use the `taggedBuilds` object. It's a dictionary that maps tag names\nto specific builds, where:\n- the key is the tag name, for example `latest` or `beta`\n- the value is either `null` or an object with a build ID\n\nChanging tags is a patch operation. Only the tags that you provide in this object are updated.\n\nNote that you can assign multiple tags to a single build, but you can't assign the same tag to multiple builds.\n\n- To create or reassign a tag, provide the tag name with a build ID. For example, to assign\nthe `latest` tag to a build, use:\n\n```json\n{\n \"latest\": { \"buildId\": \"z2EryhbfhgSyqj6Hn\" }\n}\n```\n\n- To remove a tag from a build, provide the tag name with a `null` value. For example, to remove the `beta` tag, use:\n\n```json\n{\n \"beta\": null\n}\n```\n\n- You can perform multiple actions at once. The following example reassigns `latest`\nand removes `beta`, while preserving other existing tags:\n\n```json\n{\n \"latest\": { \"buildId\": \"z2EryhbfhgSyqj6Hn\" },\n \"beta\": null\n}\n```\n",
"operationId": "actor_put",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateActorRequest"
},
"examples": {
"common": {
"summary": "Common example",
"value": {
"name": "MyActor",
"description": "My favourite Actor!",
"isPublic": false,
"actorPermissionLevel": "LIMITED_PERMISSIONS",
"seoTitle": "My Actor",
"seoDescription": "My Actor is the best",
"title": "My Actor",
"versions": [
{
"versionNumber": "0.0",
"sourceType": "SOURCE_FILES",
"envVars": [
{
"name": "DOMAIN",
"value": "http://example.com",
"isSecret": false
},
{
"name": "SECRET_PASSWORD",
"value": "MyTopSecretPassword123",
"isSecret": true
}
],
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
}
],
"categories": [],
"defaultRunOptions": {
"build": "latest",
"timeoutSecs": 3600,
"memoryMbytes": 2048,
"restartOnError": false
}
}
},
"taggedBuildsCreateOrReassignTag": {
"summary": "Create or reassign a build tag",
"value": {
"name": "MyActor",
"isPublic": false,
"versions": [],
"taggedBuilds": {
"latest": {
"buildId": "z2EryhbfhgSyqj6Hn"
}
}
}
},
"taggedBuildsRemoveTag": {
"summary": "Remove a build tag",
"value": {
"name": "MyActor",
"isPublic": false,
"versions": [],
"taggedBuilds": {
"latest": null
}
}
},
"taggedBuildsMultipleOperations": {
"summary": "Update multiple build tags at once",
"value": {
"name": "MyActor",
"isPublic": false,
"versions": [],
"taggedBuilds": {
"latest": {
"buildId": "z2EryhbfhgSyqj6Hn"
},
"beta": null
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActorResponse"
},
"example": {
"data": {
"id": "zdc3Pyhyz3m8vjDeM",
"userId": "wRsJZtadYvn4mBZmm",
"name": "MyActor",
"username": "jane35",
"description": "My favourite Actor!",
"isPublic": false,
"actorPermissionLevel": "LIMITED_PERMISSIONS",
"createdAt": "2019-07-08T11:27:57.401Z",
"modifiedAt": "2019-07-08T14:01:05.546Z",
"stats": {
"totalBuilds": 9,
"totalRuns": 16,
"totalUsers": 6,
"totalUsers7Days": 2,
"totalUsers30Days": 6,
"totalUsers90Days": 6,
"totalMetamorphs": 2,
"lastRunStartedAt": "2019-07-08T14:01:05.546Z"
},
"versions": [
{
"versionNumber": "0.1",
"envVars": null,
"sourceType": "SOURCE_FILES",
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
},
{
"versionNumber": "0.2",
"sourceType": "GIT_REPO",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"gitRepoUrl": "https://github.com/jane35/my-actor"
},
{
"versionNumber": "0.3",
"sourceType": "TARBALL",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip"
},
{
"versionNumber": "0.4",
"sourceType": "GITHUB_GIST",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89"
}
],
"defaultRunOptions": {
"build": "latest",
"timeoutSecs": 3600,
"memoryMbytes": 2048,
"restartOnError": false
},
"exampleRunInput": {
"body": "{ \"helloWorld\": 123 }",
"contentType": "application/json; charset=utf-8"
},
"isDeprecated": false,
"deploymentKey": "ssh-rsa AAAA ...",
"title": "My Actor",
"taggedBuilds": {
"latest": {
"buildId": "z2EryhbfhgSyqj6Hn",
"buildNumber": "0.0.2",
"finishedAt": "2019-06-10T11:15:49.286Z"
}
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor",
"https://docs.apify.com/api/v2#/reference/actors/update-actor",
"https://docs.apify.com/api/v2#tag/ActorsActor-object/operation/act_put"
],
"x-js-parent": "ActorClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#update",
"x-py-parent": "ActorClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#update"
},
"delete": {
"tags": [
"Actors"
],
"summary": "Delete Actor",
"description": "Deletes an Actor with the specified ID.",
"operationId": "actor_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
}
],
"responses": {
"204": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor",
"https://docs.apify.com/api/v2#/reference/actors/delete-actor",
"https://docs.apify.com/api/v2#tag/ActorsActor-object/operation/act_delete"
],
"x-js-parent": "ActorClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#delete"
}
},
"/v2/actors/{actorId}/versions": {
"get": {
"tags": [
"Actors/Actor versions"
],
"summary": "Get list of versions",
"description": "Gets the list of versions of a specific Actor. The response is a JSON object\nwith the list of [Version objects](#/reference/actors/version-object), where each\ncontains basic information about a single version.\n",
"operationId": "actor_versions_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfVersionsResponse"
},
"example": {
"data": {
"total": 5,
"items": [
{
"versionNumber": "0.1",
"envVars": null,
"sourceType": "SOURCE_FILES",
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
},
{
"versionNumber": "0.2",
"sourceType": "GIT_REPO",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"gitRepoUrl": "https://github.com/jane35/my-actor"
},
{
"versionNumber": "0.3",
"sourceType": "TARBALL",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip"
},
{
"versionNumber": "0.4",
"sourceType": "GITHUB_GIST",
"envVars": null,
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89"
}
]
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions",
"https://docs.apify.com/api/v2#/reference/actors/get-list-of-versions",
"https://docs.apify.com/api/v2#tag/ActorsVersion-collection/operation/act_versions_get"
],
"x-py-parent": "ActorVersionCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#list"
},
"post": {
"tags": [
"Actors/Actor versions"
],
"summary": "Create version",
"description": "Creates a version of an Actor using values specified in a [Version\nobject](#/reference/actors/version-object) passed as JSON in the POST\npayload.\n\nThe request must specify `versionNumber` and `sourceType` parameters (as\nstrings) in the JSON payload and a `Content-Type: application/json` HTTP\nheader.\n\nEach `sourceType` requires its own additional properties to be passed to the\nJSON payload object. These are outlined in the [Version\nobject](#/reference/actors/version-object) table below and in more detail in\nthe [Apify\ndocumentation](https://docs.apify.com/platform/actors/development/deployment/source-types).\n\nFor example, if an Actor's source code is stored in a [GitHub\nrepository](https://docs.apify.com/platform/actors/development/deployment/source-types#git-repository),\nyou will set the `sourceType` to `GIT_REPO` and pass the repository's URL in\nthe `gitRepoUrl` property.\n\n```\n{\n \"versionNumber\": \"0.1\",\n \"sourceType\": \"GIT_REPO\",\n \"gitRepoUrl\": \"https://github.com/my-github-account/actor-repo\"\n}\n```\n\nThe response is the [Version object](#/reference/actors/version-object) as\nreturned by the [Get version](#/reference/actors/version-object/get-version) endpoint.\n",
"operationId": "actor_versions_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateVersionRequest"
},
"example": {
"versionNumber": "0.1",
"sourceType": "GIT_REPO",
"gitRepoUrl": "https://github.com/my-github-account/actor-repo"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/versions/0.0"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version",
"https://docs.apify.com/api/v2#/reference/actors/create-version",
"https://docs.apify.com/api/v2#tag/ActorsVersion-collection/operation/act_versions_post"
],
"x-py-parent": "ActorVersionCollectionClientAsync",
"x-py-name": "create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#create"
}
},
"/v2/actors/{actorId}/versions/{versionNumber}": {
"get": {
"tags": [
"Actors/Actor versions"
],
"summary": "Get version",
"description": "Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor.\n",
"operationId": "actor_version_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/version-object/get-version",
"https://docs.apify.com/api/v2#/reference/actors/get-version",
"https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_get"
],
"x-py-parent": "ActorVersionClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#get"
},
"put": {
"tags": [
"Actors/Actor versions"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateVersionRequest"
},
"example": {
"versionNumber": "0.0",
"sourceType": "SOURCE_FILES",
"envVars": [
{
"name": "DOMAIN",
"value": "http://example.com",
"isSecret": false
},
{
"name": "SECRET_PASSWORD",
"value": "MyTopSecretPassword123",
"isSecret": true
}
],
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-py-parent": "ActorVersionClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#update",
"summary": "Update version",
"description": "Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.\n\nIf the object does not define a specific property, its value will not be\nupdated.\n\nThe request needs to specify the `Content-Type: application/json` HTTP\nheader!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL. ([More\ninfo](#/introduction/authentication)).\n\nThe response is the [Version object](#/reference/actors/version-object) as\nreturned by the [Get version](#/reference/actors/version-object/get-version) endpoint.\n",
"operationId": "actor_version_put",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/version-object/update-version",
"https://docs.apify.com/api/v2#/reference/actors/update-version",
"https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_put"
]
},
"post": {
"tags": [
"Actors/Actor versions"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateVersionRequest"
},
"example": {
"versionNumber": "0.0",
"sourceType": "SOURCE_FILES",
"envVars": [
{
"name": "DOMAIN",
"value": "http://example.com",
"isSecret": false
},
{
"name": "SECRET_PASSWORD",
"value": "MyTopSecretPassword123",
"isSecret": true
}
],
"applyEnvVarsToBuild": false,
"buildTag": "latest",
"sourceFiles": []
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-py-parent": "ActorVersionClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#update",
"summary": "Update version (POST)",
"description": "Updates Actor version using values specified by a [Version object](#/reference/actors/version-object) passed as JSON in the POST payload.\nThis endpoint is an alias for the [`PUT` update version](#tag/ActorsVersion-object/operation/act_version_put) method and behaves identically.\n",
"operationId": "actor_version_post",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/version-object/update-version",
"https://docs.apify.com/api/v2#/reference/actors/update-version",
"https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_post"
]
},
"delete": {
"tags": [
"Actors/Actor versions"
],
"summary": "Delete version",
"description": "Deletes a specific version of Actor's source code.\n",
"operationId": "actor_version_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
}
],
"responses": {
"204": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/version-object/delete-version",
"https://docs.apify.com/api/v2#/reference/actors/delete-version",
"https://docs.apify.com/api/v2#tag/ActorsVersion-object/operation/act_version_delete"
]
}
},
"/v2/actors/{actorId}/versions/{versionNumber}/env-vars": {
"get": {
"tags": [
"Actors/Actor versions"
],
"summary": "Get list of environment variables",
"description": "Gets the list of environment variables for a specific version of an Actor.\nThe response is a JSON object with the list of [EnvVar objects](#/reference/actors/environment-variable-object), where each contains basic information about a single environment variable.\n",
"operationId": "actor_version_envVars_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfEnvVarsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables",
"https://docs.apify.com/api/v2#/reference/actors/get-list-of-environment-variables",
"https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-collection/operation/act_version_envVars_get"
],
"x-py-parent": "ActorEnvVarCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#list"
},
"post": {
"tags": [
"Actors/Actor versions"
],
"summary": "Create environment variable",
"description": "Creates an environment variable of an Actor using values specified in a\n[EnvVar object](#/reference/actors/environment-variable-object) passed as\nJSON in the POST payload.\n\nThe request must specify `name` and `value` parameters (as strings) in the\nJSON payload and a `Content-Type: application/json` HTTP header.\n\n```\n{\n \"name\": \"ENV_VAR_NAME\",\n \"value\": \"my-env-var\"\n}\n```\n\nThe response is the [EnvVar\nobject](#/reference/actors/environment-variable-object) as returned by the [Get environment\nvariable](#/reference/actors/environment-variable-object/get-environment-variable)\nendpoint.\n",
"operationId": "actor_version_envVars_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarRequest"
},
"example": {
"name": "ENV_VAR_NAME",
"value": "my-env-var"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/versions/1.0/env-vars/ENV_VAR_NAME"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarResponse"
},
"example": {
"data": {
"name": "MY_ENV_VAR",
"value": "my-value",
"isSecret": false
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable",
"https://docs.apify.com/api/v2#/reference/actors/create-environment-variable",
"https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-collection/operation/act_version_envVars_post"
],
"x-py-parent": "ActorEnvVarCollectionClientAsync",
"x-py-name": "create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#create"
}
},
"/v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}": {
"get": {
"tags": [
"Actors/Actor versions"
],
"summary": "Get environment variable",
"description": "Gets a [EnvVar object](#/reference/actors/environment-variable-object) that\ncontains all the details about a specific environment variable of an Actor.\n\nIf `isSecret` is set to `true`, then `value` will never be returned.\n",
"operationId": "actor_version_envVar_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
},
{
"name": "envVarName",
"in": "path",
"description": "The name of the environment variable",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "MY_ENV_VAR"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarResponse"
},
"example": {
"data": {
"name": "MY_ENV_VAR",
"value": "my-value",
"isSecret": false
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable",
"https://docs.apify.com/api/v2#/reference/actors/get-environment-variable",
"https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_get"
],
"x-py-parent": "ActorEnvVarClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#get"
},
"put": {
"tags": [
"Actors/Actor versions"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
},
{
"name": "envVarName",
"in": "path",
"description": "The name of the environment variable",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "MY_ENV_VAR"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarRequest"
},
"example": {
"name": "MY_ENV_VAR",
"value": "my-new-value",
"isSecret": false
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarResponse"
},
"example": {
"data": {
"name": "MY_ENV_VAR",
"value": "my-value",
"isSecret": false
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-py-parent": "ActorEnvVarClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update",
"summary": "Update environment variable",
"description": "Updates Actor environment variable using values specified by a [EnvVar\nobject](#/reference/actors/environment-variable-object)\npassed as JSON in the POST payload.\nIf the object does not define a specific property, its value will not be\nupdated.\n\nThe request needs to specify the `Content-Type: application/json` HTTP\nheader!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL. ([More\ninfo](#/introduction/authentication)).\n\nThe response is the [EnvVar object](#/reference/actors/environment-variable-object) as returned by the\n[Get environment variable](#/reference/actors/environment-variable-object/get-environment-variable)\nendpoint.\n",
"operationId": "actor_version_envVar_put",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable",
"https://docs.apify.com/api/v2#/reference/actors/update-environment-variable",
"https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put"
]
},
"post": {
"tags": [
"Actors/Actor versions"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
},
{
"name": "envVarName",
"in": "path",
"description": "The name of the environment variable",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "MY_ENV_VAR"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarRequest"
},
"example": {
"name": "MY_ENV_VAR",
"value": "my-new-value",
"isSecret": false
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvVarResponse"
},
"example": {
"data": {
"name": "MY_ENV_VAR",
"value": "my-value",
"isSecret": false
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-py-parent": "ActorEnvVarClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update",
"summary": "Update environment variable (POST)",
"description": "Updates Actor environment variable using values specified by a [EnvVar\nobject](#/reference/actors/environment-variable-object)\npassed as JSON in the POST payload.\nThis endpoint is an alias for the [`PUT` update environment variable](#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_put) method and behaves identically.\n",
"operationId": "actor_version_envVar_post",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable",
"https://docs.apify.com/api/v2#/reference/actors/update-environment-variable",
"https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_post"
]
},
"delete": {
"tags": [
"Actors/Actor versions"
],
"summary": "Delete environment variable",
"description": "Deletes a specific environment variable.",
"operationId": "actor_version_envVar_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/versionNumber"
},
{
"name": "envVarName",
"in": "path",
"description": "The name of the environment variable",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "MY_ENV_VAR"
}
}
],
"responses": {
"204": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable",
"https://docs.apify.com/api/v2#/reference/actors/delete-environment-variable",
"https://docs.apify.com/api/v2#tag/ActorsEnvironment-variable-object/operation/act_version_envVar_delete"
]
}
},
"/v2/actors/{actorId}/webhooks": {
"get": {
"tags": [
"Actors/Webhook collection"
],
"summary": "Get list of webhooks",
"description": "Gets the list of webhooks of a specific Actor. The response is a JSON with\nthe list of objects, where each object contains basic information about a single webhook.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\n\nBy default, the records are sorted by the `createdAt` field in ascending\norder, to sort the records in descending order, use the `desc=1` parameter.\n",
"operationId": "actor_webhooks_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfWebhooksResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/webhook-collection/get-list-of-webhooks",
"https://docs.apify.com/api/v2#/reference/actors/get-list-of-webhooks",
"https://docs.apify.com/api/v2#tag/ActorsWebhook-collection/operation/act_webhooks_get"
]
}
},
"/v2/actors/{actorId}/builds": {
"get": {
"tags": [
"Actors/Actor builds"
],
"summary": "Get list of builds",
"description": "Gets the list of builds of a specific Actor. The response is a JSON with the\nlist of objects, where each object contains basic information about a single build.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\n\nBy default, the records are sorted by the `startedAt` field in ascending order,\ntherefore you can use pagination to incrementally fetch all builds while new\nones are still being started. To sort the records in descending order, use\nthe `desc=1` parameter.\n",
"operationId": "actors_builds_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descStartedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfBuildsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds",
"https://docs.apify.com/api/v2#/reference/actors/get-list-of-builds",
"https://docs.apify.com/api/v2#tag/ActorsBuild-collection/operation/act_builds_get"
],
"x-js-parent": "BuildCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildCollectionClient#list",
"x-py-parent": "BuildCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync#list"
},
"post": {
"tags": [
"Actors/Actor builds"
],
"summary": "Build Actor",
"description": "Builds an Actor.\nThe response is the build object as returned by the\n[Get build](#/reference/actors/build-object/get-build) endpoint.\n",
"operationId": "actors_builds_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"name": "version",
"in": "query",
"description": "Actor version number to be built.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "0.0"
}
},
{
"name": "useCache",
"in": "query",
"description": "If `true` or `1`, the system will use a cache to speed up the build\nprocess. By default, cache is not used.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "betaPackages",
"in": "query",
"description": "If `true` or `1` then the Actor is built with beta versions of Apify NPM\npackages. By default, the build uses `latest` packages.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "tag",
"in": "query",
"description": "Tag to be applied to the build on success. By default, the tag is taken\nfrom Actor version's `buildTag` property.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "latest"
}
},
{
"$ref": "#/components/parameters/waitForFinishBuild"
}
],
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/runs/HG7ML7M8z78YcAPEB"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuildResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor",
"https://docs.apify.com/api/v2#/reference/actors/build-actor",
"https://docs.apify.com/api/v2#tag/ActorsBuild-collection/operation/act_builds_post"
],
"x-js-parent": "ActorClient",
"x-js-name": "build",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#build",
"x-py-parent": "ActorClientAsync",
"x-py-name": "build",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#build"
}
},
"/v2/actors/{actorId}/builds/default": {
"get": {
"tags": [
"Actors/Actor builds"
],
"summary": "Get default build",
"description": "Get the default build for an Actor.\n\nUse the optional `waitForFinish` parameter to synchronously wait for the build to finish.\nThis avoids the need for periodic polling when waiting for the build to complete.\n\nThis endpoint does not require an authentication token. Instead, calls are authenticated using the Actor's unique ID.\nHowever, if you access the endpoint without a token, certain attributes (e.g., `usageUsd` and `usageTotalUsd`) will be hidden.\n",
"operationId": "actor_build_default_get",
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/waitForFinishBuild"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuildResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"x-js-parent": "ActorClient",
"x-js-name": "defaultBuild",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#defaultBuild",
"x-py-parent": "ActorClient",
"x-py-name": "default_build",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClient#default_build"
}
},
"/v2/actors/{actorId}/builds/{buildId}/openapi.json": {
"get": {
"tags": [
"Actors/Actor builds"
],
"summary": "Get OpenAPI definition",
"description": "Get the OpenAPI definition for Actor builds. Two similar endpoints are available:\n\n- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.\n\n- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.\n\nGet the OpenAPI definition for a specific Actor build.\n\nTo fetch the default Actor build, simply pass `default` as the `buildId`.\nAuthentication is based on the build's unique ID. No authentication token is required.\n\n:::note\n\nYou can also use the [`/api/v2/actor-build-openapi-json-get`](/api/v2/actor-build-openapi-json-get) endpoint to get the OpenAPI definition for a build.\n\n:::\n",
"operationId": "actor_openapi_json_get",
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/buildIdWithDefault"
}
],
"responses": {
"200": {
"description": "The OpenAPI specification document for the Actor build.",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "A standard OpenAPI 3.x JSON document."
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
}
}
},
"/v2/actors/{actorId}/builds/{buildId}": {
"get": {
"tags": [
"Actors/Actor builds"
],
"summary": "Get build",
"description": "By passing the optional `waitForFinish` parameter the API endpoint will\nsynchronously wait for the build to finish.\nThis is useful to avoid periodic polling when waiting for an Actor build to\nfinish.\n\nThis endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. However,\nif you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.\n",
"operationId": "actors_build_get",
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/buildId"
},
{
"$ref": "#/components/parameters/waitForFinishBuild"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuildResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": true,
"x-deprecated-description": "API endpoints related to build of the Actor were moved under new namespace [`actor-builds`](#/reference/actor-builds). Gets an object that contains all the details about a specific build of an Actor.",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/build-object/get-build",
"https://docs.apify.com/api/v2#/reference/actors/get-build",
"https://docs.apify.com/api/v2#tag/ActorsBuild-object/operation/act_build_get"
]
}
},
"/v2/actors/{actorId}/builds/{buildId}/abort": {
"post": {
"tags": [
"Actors/Actor builds"
],
"summary": "Abort build",
"description": "**[DEPRECATED]** API endpoints related to build of the Actor were moved\nunder new namespace [`actor-builds`](#/reference/actor-builds). Aborts an\nActor build and returns an object that contains all the details about the\nbuild.\n\nOnly builds that are starting or running are aborted. For builds with status\n`FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.\n",
"operationId": "actors_build_abort_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/buildId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuildResponse"
},
"example": {
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "klmdEpoiojmdEMlk3",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "ABORTED",
"meta": {
"origin": "WEB",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"durationMillis": 1000,
"runTimeSecs": 5.718,
"computeUnits": 0.012699444444444444
},
"options": {
"useCache": false,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"usage": {
"ACTOR_COMPUTE_UNITS": 0.08
},
"usageTotalUsd": 0.02,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.02
},
"buildNumber": "0.1.1"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": true,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/abort-build/abort-build",
"https://docs.apify.com/api/v2#/reference/actors/abort-build",
"https://docs.apify.com/api/v2#tag/ActorsAbort-build/operation/act_build_abort_post"
]
}
},
"/v2/actors/{actorId}/runs": {
"get": {
"tags": [
"Actors/Actor runs"
],
"summary": "Get list of runs",
"description": "Gets the list of runs of a specific Actor. The response is a list of\nobjects, where each object contains basic information about a single Actor run.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 array elements.\n\nBy default, the records are sorted by the `startedAt` field in ascending\norder, therefore you can use pagination to incrementally fetch all records while\nnew ones are still being created. To sort the records in descending order, use\n`desc=1` parameter. You can also filter runs by status ([available\nstatuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)).\n",
"operationId": "actors_runs_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descStartedAt"
},
{
"$ref": "#/components/parameters/status"
},
{
"$ref": "#/components/parameters/startedAfter"
},
{
"$ref": "#/components/parameters/startedBefore"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfRunsResponse"
},
"examples": {
"example": {
"$ref": "#/components/examples/ListOfRunsResponseExample"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs",
"https://docs.apify.com/api/v2#/reference/actors/get-list-of-runs",
"https://docs.apify.com/api/v2#tag/ActorsRun-collection/operation/act_runs_get"
],
"x-js-parent": "RunCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunCollectionClient#list",
"x-py-parent": "RunCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunCollectionClientAsync#list"
},
"post": {
"tags": [
"Actors/Actor runs"
],
"summary": "Run Actor",
"description": "Runs an Actor and immediately returns without waiting for the run to finish.\n\nThe POST payload including its `Content-Type` header is passed as `INPUT` to\nthe Actor (usually `application/json`).\n\nThe Actor is started with the default options; you can override them using\nvarious URL query parameters.\n\nThe response is the Run object as returned by the [Get\nrun](#/reference/actor-runs/run-object-and-its-storages/get-run) API\nendpoint.\n\nIf you want to wait for the run to finish and receive the actual output of\nthe Actor as the response, please use one of the [Run Actor\nsynchronously](#/reference/actors/run-actor-synchronously) API endpoints\ninstead.\n\nTo fetch the Actor run results that are typically stored in the default\ndataset, you'll need to pass the ID received in the `defaultDatasetId` field\nreceived in the response JSON to the [Get dataset items](#/reference/datasets/item-collection/get-items)\nAPI endpoint.\n",
"operationId": "actors_runs_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/waitForFinishRun"
},
{
"$ref": "#/components/parameters/webhooks"
},
{
"name": "forcePermissionLevel",
"in": "query",
"description": "Overrides the Actor's permission level for this specific run. Use to test restricted permissions\nbefore deploying changes to your Actor or to temporarily elevate or restrict access. If you don't specify this\nparameter, the Actor uses its configured default permission level. For more information on permissions, see the\n[documentation](https://docs.apify.com/platform/actors/development/permissions).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"LIMITED_PERMISSIONS",
"FULL_PERMISSIONS"
],
"example": "LIMITED_PERMISSIONS"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/runs/HG7ML7M8z78YcAPEB"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor",
"https://docs.apify.com/api/v2#/reference/actors/run-actor",
"https://docs.apify.com/api/v2#tag/ActorsRun-collection/operation/act_runs_post"
],
"x-js-parent": "ActorClient",
"x-js-name": "start",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#start",
"x-py-parent": "ActorClientAsync",
"x-py-name": "call",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#call"
}
},
"/v2/actors/{actorId}/run-sync": {
"post": {
"tags": [
"Actors/Actor runs"
],
"summary": "Run Actor synchronously and return key-value store record",
"description": "Runs a specific Actor and returns a key-value store record.\n\nThe POST payload including its `Content-Type` header is passed as `INPUT` to\nthe Actor (usually application/json).\n\nThe response contains the record stored under the `OUTPUT` key in the run's\ndefault key-value store. This is a legacy approach that has been replaced by\nthe Actor [output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);\nActors aren't required to store a record under this key, so the response may\nnot contain any data. Use the `outputRecordKey` query parameter to return a\ndifferent record.\n\nThe Actor is started with the default options; you can override them using\nvarious URL query parameters.\nIf the Actor run exceeds 300 seconds,\nthe HTTP response will have status 408 (Request Timeout).\n\nBeware that it might be impossible to maintain an idle HTTP connection for a\nlong period of time, due to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nTo run the Actor asynchronously, use the [Run\nActor](#/reference/actors/run-collection/run-actor) API endpoint instead.\n",
"operationId": "actor_runSync_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/outputRecordKey"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/webhooks"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"bar": "foo"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/with-input",
"https://docs.apify.com/api/v2#/reference/actors/with-input",
"https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_post"
]
},
"get": {
"tags": [
"Actors/Actor runs"
],
"summary": "Run Actor synchronously without input",
"description": "Runs a specific Actor and returns a key-value store record. The response contains the\nrecord stored under the `OUTPUT` key in the run's default key-value store.\nThis is a legacy approach that has been replaced by the Actor\n[output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);\nthe record may not exist, in which case the response contains no data. Use the\n`outputRecordKey` query parameter to return a different record.\nThe run must finish in 300 seconds\notherwise the API endpoint returns a timeout error.\nThe Actor is not passed any input.\n\nBeware that it might be impossible to maintain an idle HTTP connection for a\nlong period of time,\ndue to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nTo run the Actor asynchronously, use the [Run\nActor](#/reference/actors/run-collection/run-actor) API endpoint instead.\n",
"operationId": "actor_runSync_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/outputRecordKey"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/webhooks"
}
],
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously/without-input",
"https://docs.apify.com/api/v2#/reference/actors/without-input",
"https://docs.apify.com/api/v2#tag/ActorsRun-actor-synchronously/operation/act_runSync_get"
]
}
},
"/v2/actors/{actorId}/run-sync-get-dataset-items": {
"post": {
"tags": [
"Actors/Actor runs"
],
"summary": "Run Actor synchronously and get dataset items",
"description": "Runs a specific Actor and returns its dataset items.\n\nThe POST payload including its `Content-Type` header is passed as `INPUT` to\nthe Actor (usually `application/json`).\nThe HTTP response contains the Actors dataset items, while the format of\nitems depends on specifying dataset items' `format` parameter.\n\nYou can send all the same options in parameters as the [Get Dataset\nItems](#/reference/datasets/item-collection/get-items) API endpoint.\n\nThe Actor is started with the default options; you can override them using\nURL query parameters.\nIf the Actor run exceeds 300 seconds,\nthe HTTP response will return the 408 status code (Request Timeout).\n\nBeware that it might be impossible to maintain an idle HTTP connection for a\nlong period of time,\ndue to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nTo run the Actor asynchronously, use the [Run\nActor](#/reference/actors/run-collection/run-actor) API endpoint instead.\n",
"operationId": "actor_runSyncGetDatasetItems_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/webhooks"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"example": [
{
"myValue": "some value",
"myOtherValue": "some other value"
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-with-input-and-get-dataset-items",
"https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-with-input-and-get-dataset-items",
"https://docs.apify.com/api/v2#tag/ActorsRun-Actor-synchronously-and-get-dataset-items/operation/act_runSyncGetDatasetItems_post"
]
},
"get": {
"tags": [
"Actors/Actor runs"
],
"summary": "Run Actor synchronously without input and get dataset items",
"description": "Runs a specific Actor and returns its dataset items.\nThe run must finish in 300 seconds\notherwise the API endpoint returns a timeout error.\nThe Actor is not passed any input.\n\nIt allows to send all possible options in parameters from [Get Dataset\nItems](#/reference/datasets/item-collection/get-items) API endpoint.\n\nBeware that it might be impossible to maintain an idle HTTP connection for a\nlong period of time,\ndue to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nTo run the Actor asynchronously, use the [Run\nActor](#/reference/actors/run-collection/run-actor) API endpoint instead.\n",
"operationId": "actor_runSyncGetDatasetItems_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/webhooks"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
}
],
"responses": {
"201": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
},
"example": [
{
"myValue": "some value",
"myOtherValue": "some other value"
}
]
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-and-get-dataset-items/run-actor-synchronously-without-input-and-get-dataset-items",
"https://docs.apify.com/api/v2#/reference/actors/run-actor-synchronously-without-input-and-get-dataset-items",
"https://docs.apify.com/api/v2#tag/ActorsRun-Actor-synchronously-and-get-dataset-items/operation/act_runSyncGetDatasetItems_get"
]
}
},
"/v2/actors/{actorId}/validate-input": {
"post": {
"tags": [
"Actors"
],
"summary": "Validate Actor input",
"description": "Validates the JSON payload against the Actor's\n[input schema](https://docs.apify.com/actors/development/actor-definition/input-schema)\ndefined in the specified build.\n\nIf the specified build has no input schema, any input is considered valid.\n",
"operationId": "actor_validateInput_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"name": "build",
"in": "query",
"description": "Actor build whose input schema is used for validation. Can be a build tag or build number.\nDefaults to the `latest` build tag.\n",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "0.1.234"
}
}
],
"requestBody": {
"description": "The Actor input as a JSON object.\n\nYou can omit fields that have a `default` in the input schema. They're\nfilled in before validation.\n",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"valid"
],
"properties": {
"valid": {
"type": "boolean",
"description": "Always `true`. The endpoint responds with `200` only when the input\npasses validation. Invalid input returns a `400` error.\n"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false
}
},
"/v2/actors/{actorId}/runs/{runId}/resurrect": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RunResponse"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actors/Actor runs"
],
"summary": "Resurrect run",
"description": "**[DEPRECATED]** API endpoints related to run of the Actor were moved under\nnew namespace [`actor-runs`](#/reference/actor-runs).Resurrects a finished\nActor run and returns an object that contains all the details about the\nresurrected run.\n\nOnly finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED`\nand `TIMED-OUT` can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted\nwith the same storages\n(the same behaviour as when the run gets migrated to the new server).\n\nFor more information, see the [Actor\ndocs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run).\n",
"operationId": "actor_run_resurrect_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/buildResurrect"
},
{
"$ref": "#/components/parameters/timeoutResurrect"
},
{
"$ref": "#/components/parameters/memoryResurrect"
},
{
"$ref": "#/components/parameters/restartOnErrorResurrect"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/resurrect-run/resurrect-run",
"https://docs.apify.com/api/v2#/reference/actors/resurrect-run",
"https://docs.apify.com/api/v2#tag/ActorsResurrect-run/operation/act_run_resurrect_post"
]
}
},
"/v2/actors/{actorId}/runs/last": {
"get": {
"tags": [
"Actors/Actor runs"
],
"summary": "Get last run",
"description": "This is not a single endpoint, but an entire group of endpoints that lets you to\nretrieve and manage the last run of given Actor or any of its default storages.\nAll the endpoints require an authentication token.\n\nThe base path represents the last Actor run object is:\n\n`/v2/actors/{actorId}/runs/last{?token,status,origin}`\n\nUsing the `status` query parameter you can ensure to only get a run with a certain status\n(e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means\nby which they were started (e.g. `origin=API`). The output of this endpoint and other query\nparameters are the same as in the [Run object](#/reference/actors/run-object) endpoint.\n\n##### Convenience endpoints for last Actor run\n\n* [Dataset](/api/v2/last-actor-runs-default-dataset)\n\n* [Key-value store](/api/v2/last-actor-runs-default-key-value-store)\n\n* [Request queue](/api/v2/last-actor-runs-default-request-queue)\n\n* [Log](/api/v2/last-actor-runs-log)\n",
"operationId": "actor_runs_last_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/waitForFinishRun"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages/get-last-run",
"https://docs.apify.com/api/v2#tag/ActorsLast-run-object-and-its-storages/operation/act_runs_last_get"
]
}
},
"/v2/actors/{actorId}/runs/last/dataset": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Get last run's default dataset",
"description": "Returns the default dataset associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the\n[Get dataset](/api/v2/dataset-get) endpoint.\n",
"operationId": "actor_runs_last_dataset_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Update last run's default dataset",
"description": "Updates the default dataset associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the\n[Update dataset](/api/v2/dataset-put) endpoint.\n",
"operationId": "actor_runs_last_dataset_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Delete last run's default dataset",
"description": "Deletes the default dataset associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the\n[Delete dataset](/api/v2/dataset-delete) endpoint.\n",
"operationId": "actor_runs_last_dataset_delete"
}
},
"/v2/actors/{actorId}/runs/last/dataset/items": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"foo": "bar"
},
{
"foo2": "bar2"
}
]
}
},
"application/jsonl": {
"schema": {
"type": "string"
},
"example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n"
},
"text/csv": {
"schema": {
"type": "string"
},
"example": "foo,bar\\nfoo2,bar2\\n"
},
"text/html": {
"schema": {
"type": "string"
},
"example": ""
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string"
}
},
"application/rss+xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
},
"application/xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default dataset"
],
"summary": "Get last run's dataset items",
"description": "Returns data stored in the default dataset of the last Actor run in the desired format.\n\nThis endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the\n[Get dataset items](/api/v2/dataset-items-get) endpoint.\n",
"operationId": "actor_runs_last_dataset_items_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
},
{
"$ref": "#/components/parameters/signature"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PutItemsRequest"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PutItemsRequest"
}
}
],
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
}
}
}
},
"400": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/PutItemResponseError"
},
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default dataset"
],
"summary": "Store items in last run's dataset",
"description": "Appends an item or an array of items to the end of the last Actor run's default dataset.\n\nThis endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the\n[Store items](/api/v2/dataset-items-post) endpoint.\n\nTo save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.\n\nBelow is a list of supported `Content-Encoding` types.\n\n* Brotli: `Content-Encoding: br`\n* Gzip: `Content-Encoding: gzip`\n* Deflate: `Content-Encoding: deflate`\n",
"operationId": "actor_runs_last_dataset_items_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
}
},
"/v2/actors/{actorId}/runs/last/dataset/statistics": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetStatisticsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"tags": [
"Last Actor run's default dataset"
],
"summary": "Get last run's dataset statistics",
"description": "Returns statistics for the last Actor run's default dataset.\n\nThis endpoint is a shortcut that resolves the last run's `defaultDatasetId` and proxies to the\n[Get dataset statistics](/api/v2/dataset-statistics-get) endpoint.\n",
"operationId": "actor_runs_last_dataset_statistics_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
]
}
},
"/v2/actors/{actorId}/runs/last/key-value-store": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Get last run's default store",
"description": "Gets an object that contains all the details about the default key-value store associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Get store](/api/v2/key-value-store-get) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStoreRequest"
},
"example": {
"name": "new-store-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Update last run's default store",
"description": "Updates the last Actor run key-value store's name and general resource access level using a value specified by a JSON object\npassed in the PUT payload.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Update store](/api/v2/key-value-store-put) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Delete last run's default store",
"description": "Deletes the last Actor run key-value store.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Delete store](/api/v2/key-value-store-delete) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_delete"
}
},
"/v2/actors/{actorId}/runs/last/key-value-store/keys": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfKeysResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"summary": "Get last run's default store's list of keys",
"description": "Returns a list of keys for the default key-value store of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the\n[Get list of keys](/api/v2/key-value-store-keys-get) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_keys_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/exclusiveStartKey"
},
{
"$ref": "#/components/parameters/limit-3"
},
{
"$ref": "#/components/parameters/collectionKeys"
},
{
"$ref": "#/components/parameters/prefixKeys"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/actors/{actorId}/runs/last/key-value-store/records": {
"get": {
"responses": {
"200": {
"description": "A ZIP archive containing the requested records.",
"headers": {},
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"summary": "Download last run's default store's records",
"description": "Downloads all records from the default key-value store of the last Actor run as a ZIP archive.\n\nThis endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the\n[Download records](/api/v2/key-value-store-records-get) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_records_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/collectionRecords"
},
{
"$ref": "#/components/parameters/prefixRecords"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
},
"*/*": {
"schema": {}
}
}
},
"302": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC"
}
}
}
},
"content": {}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"summary": "Get last run's default store's record",
"description": "Gets a value stored under a specific key in the default key-value store of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the\n[Get record](/api/v2/key-value-store-record-get) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_record_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/signature"
},
{
"$ref": "#/components/parameters/attachment-2"
}
]
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"summary": "Store record in last run's default store",
"description": "Stores a value under a specific key in the default key-value store of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the\n[Store record](/api/v2/key-value-store-record-put) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_record_put",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"summary": "Store record in last run's default store (POST)",
"description": "Stores a value under a specific key in the default key-value store of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the\n[Store record](/api/v2/key-value-store-record-post) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_record_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default key-value store"
],
"summary": "Delete last run's default store's record",
"description": "Removes a record specified by a key from the default key-value store of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultKeyValueStoreId` and then using the\n[Delete record](/api/v2/key-value-store-record-delete) endpoint.\n",
"operationId": "actor_runs_last_keyValueStore_record_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Get last run's default request queue",
"description": "Returns the default request queue associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Get request queue](/api/v2/request-queue-get) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateRequestQueueRequest"
},
{
"example": {
"name": "new-request-queue-name"
}
}
]
},
"example": {
"name": "new-request-queue-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Update last run's default request queue",
"description": "Updates the default request queue associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Update request queue](/api/v2/request-queue-put) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Delete last run's default request queue",
"description": "Deletes the default request queue associated with the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Delete request queue](/api/v2/request-queue-delete) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_delete"
}
},
"/v2/actors/{actorId}/runs/last/request-queue/requests": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "List last run's default request queue's requests",
"description": "Returns a list of requests from the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[List requests](/api/v2/request-queue-requests-get) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_requests_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/exclusiveStartId"
},
{
"$ref": "#/components/parameters/listLimit"
},
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/filter"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Add request to last run's default request queue",
"description": "Adds a request to the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Add request](/api/v2/request-queue-requests-post) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_requests_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue/requests/batch": {
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestWithoutId"
},
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchAddResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Batch add requests to last run's default request queue",
"description": "Adds requests to the default request queue of the last Actor run in batch.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Add requests](/api/v2/request-queue-requests-batch-post) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_requests_batch_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
]
},
"delete": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestDraftDelete"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDeleteResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Batch delete requests from last run's default request queue",
"description": "Batch-deletes requests from the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Delete requests](/api/v2/request-queue-requests-batch-delete) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_requests_batch_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/contentTypeJson"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue/requests/unlock": {
"post": {
"responses": {
"200": {
"description": "Number of requests that were unlocked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Unlock requests in last run's default request queue",
"description": "Unlocks requests in the default request queue of the last Actor run that are currently locked by the client.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Unlock requests](/api/v2/request-queue-requests-unlock-post) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_requests_unlock_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Get request from last run's default request queue",
"description": "Returns a request from the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Get request](/api/v2/request-queue-request-get) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_request_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
}
]
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Update request in last run's default request queue",
"description": "Updates a request in the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Update request](/api/v2/request-queue-request-put) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_request_put",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/forefront"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Delete request from last run's default request queue",
"description": "Deletes a request from the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Delete request](/api/v2/request-queue-request-delete) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_request_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}/lock": {
"put": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProlongRequestLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Prolong lock on request in last run's default request queue",
"description": "Prolongs a request lock in the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_request_lock_put",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/lockForefront"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Delete lock on request in last run's default request queue",
"description": "Deletes a request lock in the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_request_lock_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/deleteForefront"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue/head": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Get last run's default request queue head",
"description": "Returns the given number of first requests from the default request queue of the last Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Get head](/api/v2/request-queue-head-get) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_head_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/headLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actors/{actorId}/runs/last/request-queue/head/lock": {
"post": {
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadAndLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's default request queue"
],
"summary": "Get and lock last run's default request queue head",
"description": "Returns the given number of first requests from the default request queue of the last Actor run\nand locks them for the given time.\n\nThis endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the\n[Get head and lock](/api/v2/request-queue-head-lock-post) endpoint.\n",
"operationId": "actor_runs_last_requestQueue_head_lock_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/headLockLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actors/{actorId}/runs/last/log": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2017-07-14T06:00:49.733Z Application started.\n2017-07-14T06:00:49.741Z Input: { test: 123 }\n2017-07-14T06:00:49.752Z Some useful debug information follows.\n"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's log"
],
"summary": "Get last Actor run's log",
"description": "Retrieves last Actor run's logs.\n\nThis endpoint is a shortcut for getting last Actor run's log. Same as [Get log](/api/v2/log-get) endpoint.\n",
"operationId": "actor_runs_last_log_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/stream"
},
{
"$ref": "#/components/parameters/download"
},
{
"$ref": "#/components/parameters/raw"
}
]
}
},
"/v2/actors/{actorId}/runs/last/abort": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
},
"example": {
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "BPWZBd7Z9c746JAng",
"actorTaskId": "rANaydYhUxjsnA3oz",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "ABORTED",
"statusMessage": "Actor was aborted",
"isStatusMessageTerminal": true,
"meta": {
"origin": "WEB",
"clientIp": "172.234.12.34",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"inputBodyLen": 240,
"migrationCount": 0,
"restartCount": 0,
"resurrectCount": 1,
"memAvgBytes": 35914228.4,
"memMaxBytes": 38244352,
"memCurrentBytes": 0,
"cpuAvgUsage": 0.00955965,
"cpuMaxUsage": 3.1546,
"cpuCurrentUsage": 0,
"netRxBytes": 2652,
"netTxBytes": 1338,
"durationMillis": 26239,
"runTimeSecs": 26.239,
"metamorph": 0,
"computeUnits": 0.0072886
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"buildId": "7sT5jcggjjA9fNcxF",
"exitCode": 0,
"generalAccess": "RESTRICTED",
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"storageIds": {
"datasets": {
"default": "wmKPijuyDnPZAPRMk"
},
"keyValueStores": {
"default": "eJNzqsbPiopwJcgGQ"
},
"requestQueues": {
"default": "FL35cSF7jrxr3BY39"
}
},
"isContainerServerReady": false,
"gitBranchName": "master",
"usage": {
"ACTOR_COMPUTE_UNITS": 3,
"DATASET_READS": 4,
"DATASET_WRITES": 4,
"KEY_VALUE_STORE_READS": 5,
"KEY_VALUE_STORE_WRITES": 3,
"KEY_VALUE_STORE_LISTS": 5,
"REQUEST_QUEUE_READS": 2,
"REQUEST_QUEUE_WRITES": 1,
"DATA_TRANSFER_INTERNAL_GBYTES": 1,
"DATA_TRANSFER_EXTERNAL_GBYTES": 3,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
"PROXY_SERPS": 3
},
"usageTotalUsd": 0.2654,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.072,
"DATASET_READS": 0.0004,
"DATASET_WRITES": 0.0002,
"KEY_VALUE_STORE_READS": 0.0006,
"KEY_VALUE_STORE_WRITES": 0.002,
"KEY_VALUE_STORE_LISTS": 0.004,
"REQUEST_QUEUE_READS": 0.005,
"REQUEST_QUEUE_WRITES": 0.02,
"DATA_TRANSFER_INTERNAL_GBYTES": 0.0004,
"DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16,
"PROXY_SERPS": 0.0006
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's abort"
],
"summary": "Abort Actor's last run",
"description": "Aborts the last run of the specified Actor and returns an object that\ncontains all the details about the run.\n\nThis endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run)\non the Actor's last run. Only runs that are starting or running are aborted.\nFor runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call\ndoes nothing.\n",
"operationId": "actor_runs_last_abort_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/gracefully"
}
]
}
},
"/v2/actors/{actorId}/runs/last/metamorph": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's metamorph"
],
"summary": "Metamorph Actor's last run",
"description": "Transforms the last run of the specified Actor into a run of another Actor with\na new input.\n\nThis endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run)\non the Actor's last run.\n",
"operationId": "actor_runs_last_metamorph_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/targetActorId"
},
{
"name": "build",
"in": "query",
"description": "Optional build of the target Actor.\n\nIt can be either a build tag or build number. By default, the run uses\nthe build specified in the default run configuration for the target\nActor (typically `latest`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "beta"
}
}
]
}
},
"/v2/actors/{actorId}/runs/last/reboot": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor run's reboot"
],
"summary": "Reboot Actor's last run",
"description": "Reboots the last run of the specified Actor and returns an object that\ncontains all the details about the rebooted run.\n\nThis endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run)\non the Actor's last run. Only runs with status `RUNNING` can be rebooted. The run's\ncontainer will be restarted, so any data not persisted in the key-value store, dataset,\nor request queue will be lost.\n",
"operationId": "actor_runs_last_reboot_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
]
}
},
"/v2/actors/{actorId}/runs/{runId}": {
"get": {
"tags": [
"Actors/Actor runs"
],
"summary": "Get run",
"description": "**[DEPRECATED]** API endpoints related to run of the Actor were moved under\nnew namespace [`actor-runs`](#/reference/actor-runs).\n\nGets an object that contains all the details about a specific run of an Actor.\n\nBy passing the optional `waitForFinish` parameter the API endpoint will\nsynchronously wait for the run to finish.\nThis is useful to avoid periodic polling when waiting for Actor run to\ncomplete.\n\nThis endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However,\nif you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.\n",
"operationId": "actors_run_get",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/waitForFinishRun"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": true,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/run-object/get-run",
"https://docs.apify.com/api/v2#/reference/actors/get-run",
"https://docs.apify.com/api/v2#tag/ActorsRun-object/operation/act_run_get"
]
}
},
"/v2/actors/{actorId}/runs/{runId}/abort": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
},
"example": {
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "BPWZBd7Z9c746JAng",
"actorTaskId": "rANaydYhUxjsnA3oz",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "ABORTED",
"statusMessage": "Actor was aborted",
"isStatusMessageTerminal": true,
"meta": {
"origin": "WEB",
"clientIp": "172.234.12.34",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"inputBodyLen": 240,
"migrationCount": 0,
"restartCount": 0,
"resurrectCount": 1,
"memAvgBytes": 35914228.4,
"memMaxBytes": 38244352,
"memCurrentBytes": 0,
"cpuAvgUsage": 0.00955965,
"cpuMaxUsage": 3.1546,
"cpuCurrentUsage": 0,
"netRxBytes": 2652,
"netTxBytes": 1338,
"durationMillis": 26239,
"runTimeSecs": 26.239,
"metamorph": 0,
"computeUnits": 0.0072886
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"buildId": "7sT5jcggjjA9fNcxF",
"exitCode": 0,
"generalAccess": "RESTRICTED",
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"storageIds": {
"datasets": {
"default": "wmKPijuyDnPZAPRMk"
},
"keyValueStores": {
"default": "eJNzqsbPiopwJcgGQ"
},
"requestQueues": {
"default": "FL35cSF7jrxr3BY39"
}
},
"isContainerServerReady": false,
"gitBranchName": "master",
"usage": {
"ACTOR_COMPUTE_UNITS": 3,
"DATASET_READS": 4,
"DATASET_WRITES": 4,
"KEY_VALUE_STORE_READS": 5,
"KEY_VALUE_STORE_WRITES": 3,
"KEY_VALUE_STORE_LISTS": 5,
"REQUEST_QUEUE_READS": 2,
"REQUEST_QUEUE_WRITES": 1,
"DATA_TRANSFER_INTERNAL_GBYTES": 1,
"DATA_TRANSFER_EXTERNAL_GBYTES": 3,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
"PROXY_SERPS": 3
},
"usageTotalUsd": 0.2654,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.072,
"DATASET_READS": 0.0004,
"DATASET_WRITES": 0.0002,
"KEY_VALUE_STORE_READS": 0.0006,
"KEY_VALUE_STORE_WRITES": 0.002,
"KEY_VALUE_STORE_LISTS": 0.004,
"REQUEST_QUEUE_READS": 0.005,
"REQUEST_QUEUE_WRITES": 0.02,
"DATA_TRANSFER_INTERNAL_GBYTES": 0.0004,
"DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16,
"PROXY_SERPS": 0.0006
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": true,
"tags": [
"Actors/Actor runs"
],
"summary": "Abort run",
"description": "**[DEPRECATED]** API endpoints related to run of the Actor were moved under\nnew namespace [`actor-runs`](#/reference/actor-runs). Aborts an Actor run and\nreturns an object that contains all the details about the run.\n\nOnly runs that are starting or running are aborted. For runs with status\n`FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.\n",
"operationId": "actors_run_abort_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/gracefully"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/abort-run/abort-run",
"https://docs.apify.com/api/v2#/reference/actors/abort-run",
"https://docs.apify.com/api/v2#tag/ActorsAbort-run/operation/act_run_abort_post"
]
}
},
"/v2/actors/{actorId}/runs/{runId}/metamorph": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": true,
"tags": [
"Actors/Actor runs"
],
"summary": "Metamorph run",
"description": "**[DEPRECATED]** API endpoints related to run of the Actor were moved under\nnew namespace [`actor-runs`](#/reference/actor-runs). Transforms an Actor run\ninto a run of another Actor with a new input.\n\nThis is useful if you want to use another Actor to finish the work\nof your current Actor run, without the need to create a completely new run\nand waiting for its finish.\nFor the users of your Actors, the metamorph operation is transparent, they\nwill just see your Actor got the work done.\n\nThere is a limit on how many times you can metamorph a single run. You can\ncheck the limit in [the Actor runtime limits](https://docs.apify.com/platform/limits#actor-limits).\n\nInternally, the system stops the Docker container corresponding to the Actor\nrun and starts a new container using a different Docker image.\nAll the default storages are preserved and the new input is stored under the\n`INPUT-METAMORPH-1` key in the same default key-value store.\n\nFor more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph).\n",
"operationId": "actors_run_metamorph_post",
"parameters": [
{
"$ref": "#/components/parameters/actorId"
},
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/targetActorId"
},
{
"name": "build",
"in": "query",
"description": "Optional build of the target Actor.\n\nIt can be either a build tag or build number. By default, the run uses\nthe build specified in the default run configuration for the target\nActor (typically `latest`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "beta"
}
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actors/metamorph-run/metamorph-run",
"https://docs.apify.com/api/v2#/reference/actors/metamorph-run",
"https://docs.apify.com/api/v2#tag/ActorsMetamorph-run/operation/act_run_metamorph_post"
]
}
},
"/v2/actor-tasks": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Get list of tasks",
"description": "Gets the complete list of tasks that a user has created or used.\n\nThe response is a list of objects in which each object contains essential\ninformation about a single task.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters,\nand it does not return more than a 1000 records.\n\nBy default, the records are sorted by the `createdAt` field in ascending\norder; therefore you can use pagination to incrementally fetch all tasks while new\nones are still being created. To sort the records in descending order, use\nthe `desc=1` parameter.\n",
"operationId": "actorTasks_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfTasksResponse"
},
"example": {
"data": {
"total": 2,
"offset": 0,
"limit": 1000,
"desc": false,
"count": 2,
"items": [
{
"id": "zdc3Pyhyz3m8vjDeM",
"userId": "wRsJZtadYvn4mBZmm",
"actId": "asADASadYvn4mBZmm",
"actName": "my-actor",
"name": "my-task",
"username": "janedoe",
"actUsername": "janedoe",
"createdAt": "2018-10-26T07:23:14.855Z",
"modifiedAt": "2018-10-26T13:30:49.578Z",
"stats": {
"totalRuns": 15
}
},
{
"id": "aWE3asdas3m8vjDeM",
"userId": "wRsJZtadYvn4mBZmm",
"actId": "asADASadYvn4mBZmm",
"actName": "my-actor",
"actUsername": "janedoe",
"name": "my-task-2",
"username": "janedoe",
"createdAt": "2018-10-26T07:23:14.855Z",
"modifiedAt": "2018-10-26T13:30:49.578Z",
"stats": {
"totalRuns": 4
}
}
]
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks",
"https://docs.apify.com/api/v2#/reference/actor-tasks/get-list-of-tasks",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-collection/operation/actorTasks_get"
],
"x-js-parent": "TaskCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskCollectionClient#list",
"x-py-parent": "TaskCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskCollectionClientAsync#list"
},
"post": {
"tags": [
"Actor tasks"
],
"summary": "Create task",
"description": "Create a new task with settings specified by the object passed as JSON in\nthe POST payload.\n\nThe response is the full task object as returned by the\n[Get task](/api/v2/actor-task-get) endpoint.\n\nThe request needs to specify the `Content-Type: application/json` HTTP header!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL.\n",
"operationId": "actorTasks_post",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateTaskRequest"
},
{
"example": {
"actId": "asADASadYvn4mBZmm",
"name": "my-task",
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 128
},
"input": {
"hello": "world"
}
}
}
]
},
"example": {
"actId": "asADASadYvn4mBZmm",
"name": "my-task",
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 128
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actor-tasks/zdc3Pyhyz3m8vjDeM"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task",
"https://docs.apify.com/api/v2#/reference/actor-tasks/create-task",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-collection/operation/actorTasks_post"
],
"x-js-parent": "TaskCollectionClient",
"x-js-name": "create",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskCollectionClient#create",
"x-py-parent": "TaskCollectionClientAsync",
"x-py-name": "create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskCollectionClientAsync#create"
}
},
"/v2/actor-tasks/{actorTaskId}": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Get task",
"description": "Get an object that contains all the details about a task.",
"operationId": "actorTask_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task",
"https://docs.apify.com/api/v2#/reference/actor-tasks/get-task",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-object/operation/actorTask_get"
],
"x-js-parent": "TaskClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#get",
"x-py-parent": "TaskClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#get"
},
"put": {
"tags": [
"Actor tasks"
],
"summary": "Update task",
"description": "Update settings of a task using values specified by an object passed as JSON\nin the POST payload.\n\nIf the object does not define a specific property, its value is not updated.\n\nThe `publicConfig` field carries the display configuration of the task's public\nlanding page, and `isPublic` publishes or unpublishes the task itself. Both require\nwrite permission to the task's Actor.\n\nTo publish a task, its Actor must be public and both `publicConfig.inputSchemaFields` and\n`publicConfig.datasetView` must be set. Note that an Actor can have up to 10 published tasks\nand your account up to 100. To increase these limits, [contact support](http://apify.com/contact).\nIf the task doesn't meet all these conditions, the request fails and no fields are updated,\nincluding those unrelated to publishing.\n\nPublishing lists the task among the Actor's examples and makes its input public, so anyone\ncan view and copy it. The landing page itself is shown only while `publicConfig` still\nvalidates against the Actor's current build, so a new build can stop the page from being\noffered while the task stays published and copyable.\n\nThe response is the full task object as returned by the\n[Get task](/api/v2/actor-task-get) endpoint.\n\nThe request needs to specify the `Content-Type: application/json` HTTP\nheader!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL.\n",
"operationId": "actorTask_put",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTaskRequest"
},
"example": {
"name": "my-task",
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 128
},
"input": {
"hello": "world"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Task"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task",
"https://docs.apify.com/api/v2#/reference/actor-tasks/update-task",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-object/operation/actorTask_put"
],
"x-js-parent": "TaskClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#update",
"x-py-parent": "TaskClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#update"
},
"delete": {
"tags": [
"Actor tasks"
],
"summary": "Delete task",
"description": "Delete the task specified through the `actorTaskId` parameter.",
"operationId": "actorTask_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
}
],
"responses": {
"204": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task",
"https://docs.apify.com/api/v2#/reference/actor-tasks/delete-task",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-object/operation/actorTask_delete"
],
"x-js-parent": "TaskClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#delete"
}
},
"/v2/actor-tasks/{actorTaskId}/input": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Get task input",
"description": "Returns the input of a given task.",
"operationId": "actorTask_input_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"myField1": "some-value",
"myField2": "another-value",
"myField3": 1
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input",
"https://docs.apify.com/api/v2#/reference/actor-tasks/get-task-input",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-input-object/operation/actorTask_input_get"
],
"x-js-parent": "TaskClient",
"x-js-name": "getInput",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#getInput",
"x-py-parent": "TaskClientAsync",
"x-py-name": "get_input",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#get_input"
},
"put": {
"tags": [
"Actor tasks"
],
"summary": "Update task input",
"description": "Updates the input of a task using values specified by an object passed as\nJSON in the PUT payload.\n\nIf the object does not define a specific property, its value is not updated.\n\nThe response is the full task input as returned by the\n[Get task input](#/reference/tasks/task-input-object/get-task-input) endpoint.\n\nThe request needs to specify the `Content-Type: application/json` HTTP\nheader!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL. ([More\ninfo](#/introduction/authentication)).\n",
"operationId": "actorTask_input_put",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"myField2": "updated-value"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"myField1": "some-value",
"myField2": "updated-value",
"myField3": 1
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input",
"https://docs.apify.com/api/v2#/reference/actor-tasks/update-task-input",
"https://docs.apify.com/api/v2#tag/Actor-tasksTask-input-object/operation/actorTask_input_put"
],
"x-js-parent": "TaskClient",
"x-js-name": "updateInput",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#updateInput",
"x-py-parent": "TaskClientAsync",
"x-py-name": "update_input",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#update_input"
}
},
"/v2/actor-tasks/{actorTaskId}/webhooks": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Get list of webhooks",
"description": "Gets the list of webhooks of a specific Actor task. The response is a JSON\nwith the list of objects, where each object contains basic information about a single webhook.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\n\nBy default, the records are sorted by the `createdAt` field in ascending\norder, to sort the records in descending order, use the `desc=1` parameter.\n",
"operationId": "actorTask_webhooks_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
}
]
}
}
},
"example": {
"data": {
"total": 2,
"offset": 0,
"limit": 1000,
"desc": false,
"count": 2,
"items": [
{
"id": "YiKoxjkaS9gjGTqhF",
"createdAt": "2019-12-12T07:34:14.202Z",
"modifiedAt": "2019-12-13T08:36:13.202Z",
"userId": "wRsJZtadYvn4mBZmm",
"isAdHoc": false,
"shouldInterpolateStrings": false,
"eventTypes": [
"ACTOR.RUN.SUCCEEDED"
],
"condition": {
"actorId": "hksJZtadYvn4mBuin",
"actorTaskId": "asdLZtadYvn4mBZmm",
"actorRunId": "hgdKZtadYvn4mBpoi"
},
"ignoreSslErrors": false,
"doNotRetry": false,
"requestUrl": "http://example.com/",
"payloadTemplate": "{\\n \\\"userId\\\": {{userId}}...",
"headersTemplate": "{\\n \\\"Authorization\\\": Bearer...",
"description": "this is webhook description",
"lastDispatch": {
"status": "SUCCEEDED",
"finishedAt": "2019-12-13T08:36:13.202Z"
},
"stats": {
"totalDispatches": 1
}
},
{
"id": "YiKoxjkaS9gjGTqhF",
"createdAt": "2019-12-12T07:34:14.202Z",
"modifiedAt": "2019-12-13T08:36:13.202Z",
"userId": "wRsJZtadYvn4mBZmm",
"isAdHoc": false,
"shouldInterpolateStrings": false,
"eventTypes": [
"ACTOR.RUN.SUCCEEDED"
],
"condition": {
"actorId": "hksJZtadYvn4mBuin",
"actorTaskId": "asdLZtadYvn4mBZmm",
"actorRunId": "hgdKZtadYvn4mBpoi"
},
"ignoreSslErrors": false,
"doNotRetry": false,
"requestUrl": "http://example.com/",
"payloadTemplate": "{\\n \\\"userId\\\": {{userId}}...",
"headersTemplate": "{\\n \\\"Authorization\\\": Bearer...",
"description": "this is webhook description",
"lastDispatch": {
"status": "SUCCEEDED",
"finishedAt": "2019-12-13T08:36:13.202Z"
},
"stats": {
"totalDispatches": 1
}
}
]
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/webhook-collection/get-list-of-webhooks",
"https://docs.apify.com/api/v2#/reference/actor-tasks/get-list-of-webhooks",
"https://docs.apify.com/api/v2#tag/Actor-tasksWebhook-collection/operation/actorTask_webhooks_get"
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Get list of task runs",
"description": "Get a list of runs of a specific task. The response is a list of objects,\nwhere each object contains essential information about a single task run.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters,\nand it does not return more than a 1000 array elements.\n\nBy default, the records are sorted by the `startedAt` field in ascending\norder; therefore you can use pagination to incrementally fetch all records while\nnew ones are still being created. To sort the records in descending order, use\nthe `desc=1` parameter. You can also filter runs by status ([available\nstatuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)).\n",
"operationId": "actorTask_runs_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descStartedAt"
},
{
"$ref": "#/components/parameters/status"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RunShort"
}
}
}
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/get-list-of-task-runs",
"https://docs.apify.com/api/v2#/reference/actor-tasks/get-list-of-task-runs",
"https://docs.apify.com/api/v2#tag/Actor-tasksRun-collection/operation/actorTask_runs_get"
]
},
"post": {
"tags": [
"Actor tasks"
],
"summary": "Run task",
"description": "Runs an Actor task and immediately returns without waiting for the run to\nfinish.\n\nOptionally, you can override the Actor input configuration by passing a JSON\nobject as the POST payload and setting the `Content-Type: application/json` HTTP header.\n\nNote that if the object in the POST payload does not define a particular\ninput property, the Actor run uses the default value defined by the task (or Actor's input\nschema if not defined by the task).\n\nThe response is the Actor Run object as returned by the [Get\nrun](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint.\n\nIf you want to wait for the run to finish and receive the actual output of\nthe Actor run as the response, use one of the [Run task\nsynchronously](#/reference/actor-tasks/run-task-synchronously) API endpoints\ninstead.\n\nTo fetch the Actor run results that are typically stored in the default\ndataset, you'll need to pass the ID received in the `defaultDatasetId` field\nreceived in the response JSON to the\n[Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint.\n",
"operationId": "actorTask_runs_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/waitForFinishRun"
},
{
"$ref": "#/components/parameters/webhooks"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/actor-tasks/zdc3Pyhyz3m8vjDeM/runs/HG7ML7M8z78YcAPEB"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Run"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task",
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task",
"https://docs.apify.com/api/v2#tag/Actor-tasksRun-collection/operation/actorTask_runs_post"
],
"x-js-parent": "TaskClient",
"x-js-name": "start",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#start",
"x-py-parent": "TaskClientAsync",
"x-py-name": "call",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#call"
}
},
"/v2/actor-tasks/{actorTaskId}/run-sync": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Run task synchronously",
"description": "Runs an Actor task and synchronously returns a key-value store record.\n\nThe response contains the record stored under the `OUTPUT` key in the run's\ndefault key-value store. This is a legacy approach that has been replaced by\nthe Actor [output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);\nActors aren't required to store a record under this key, so the response may\nnot contain any data. Use the `outputRecordKey` query parameter to return a\ndifferent record.\n\nThe run must finish in 300 seconds\notherwise the HTTP request fails with a timeout error (this won't abort\nthe run itself).\n\nBeware that it might be impossible to maintain an idle HTTP connection for\nan extended period, due to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\n\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nTo run the Task asynchronously, use the\n[Run task asynchronously](#/reference/actor-tasks/run-collection/run-task)\nendpoint instead.\n",
"operationId": "actorTask_runSync_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/outputRecordKey"
},
{
"$ref": "#/components/parameters/webhooks"
}
],
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"bar": "foo"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously/run-task-synchronously-get",
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-get",
"https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_get"
]
},
"post": {
"tags": [
"Actor tasks"
],
"summary": "Run task synchronously",
"description": "Runs an Actor task and synchronously returns a key-value store record.\n\nThe response contains the record stored under the `OUTPUT` key in the run's\ndefault key-value store. This is a legacy approach that has been replaced by\nthe Actor [output object](https://docs.apify.com/platform/actors/development/actor-definition/output-schema#output-object-definition);\nActors aren't required to store a record under this key, so the response may\nnot contain any data. Use the `outputRecordKey` query parameter to return a\ndifferent record.\n\nThe run must finish in 300 seconds\notherwise the HTTP request fails with a timeout error (this won't abort\nthe run itself).\n\nOptionally, you can override the Actor input configuration by passing a JSON\nobject as the POST payload and setting the `Content-Type: application/json` HTTP header.\n\nNote that if the object in the POST payload does not define a particular\ninput property, the Actor run uses the default value defined by the task (or Actor's input\nschema if not defined by the task).\n\nBeware that it might be impossible to maintain an idle HTTP connection for\nan extended period, due to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\n\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nInput fields from Actor task configuration can be overloaded with values\npassed as the POST payload.\n\nJust make sure to specify `Content-Type` header to be `application/json` and\ninput to be an object.\n\nTo run the task asynchronously, use the [Run\ntask](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.\n",
"operationId": "actorTask_runSync_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/outputRecordKey"
},
{
"$ref": "#/components/parameters/webhooks"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"bar": "foo"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously/run-task-synchronously-post",
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-post",
"https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously/operation/actorTask_runSync_post"
]
}
},
"/v2/actor-tasks/{actorTaskId}/run-sync-get-dataset-items": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Run task synchronously and get dataset items",
"description": "Run a specific task and return its dataset items.\n\nThe run must finish in 300 seconds\notherwise the HTTP request fails with a timeout error (this won't abort\nthe run itself).\n\nYou can send all the same options in parameters as the [Get Dataset\nItems](#/reference/datasets/item-collection/get-items) API endpoint.\n\nBeware that it might be impossible to maintain an idle HTTP connection for\nan extended period, due to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\n\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nTo run the Task asynchronously, use the [Run task\nasynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint\ninstead.\n",
"operationId": "actorTask_runSyncGetDatasetItems_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/webhooks"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
}
],
"responses": {
"201": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-get",
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-get",
"https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_get"
]
},
"post": {
"tags": [
"Actor tasks"
],
"summary": "Run task synchronously and get dataset items",
"description": "Runs an Actor task and synchronously returns its dataset items.\n\nThe run must finish in 300 seconds\notherwise the HTTP request fails with a timeout error (this won't abort\nthe run itself).\n\nOptionally, you can override the Actor input configuration by passing a JSON\nobject as the POST payload and setting the `Content-Type: application/json` HTTP header.\n\nNote that if the object in the POST payload does not define a particular\ninput property, the Actor run uses the default value defined by the task (or the Actor's\ninput schema if not defined by the task).\n\nYou can send all the same options in parameters as the [Get Dataset\nItems](#/reference/datasets/item-collection/get-items) API endpoint.\n\nBeware that it might be impossible to maintain an idle HTTP connection for\nan extended period, due to client timeout or network conditions. Make sure your HTTP client is\nconfigured to have a long enough connection timeout.\n\nIf the connection breaks, you will not receive any information about the run\nand its status.\n\nInput fields from Actor task configuration can be overloaded with values\npassed as the POST payload.\n\nJust make sure to specify the `Content-Type` header as `application/json`\nand that the input is an object.\n\nTo run the task asynchronously, use the [Run\ntask](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.\n",
"operationId": "actorTask_runSyncGetDatasetItems_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/timeout"
},
{
"$ref": "#/components/parameters/memory"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnError"
},
{
"$ref": "#/components/parameters/build"
},
{
"$ref": "#/components/parameters/webhooks"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"foo": "bar"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items/run-task-synchronously-and-get-dataset-items-post",
"https://docs.apify.com/api/v2#/reference/actor-tasks/run-task-synchronously-and-get-dataset-items-post",
"https://docs.apify.com/api/v2#tag/Actor-tasksRun-task-synchronously-and-get-dataset-items/operation/actorTask_runSyncGetDatasetItems_post"
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last": {
"get": {
"tags": [
"Actor tasks"
],
"summary": "Get last run",
"description": "This is not a single endpoint, but an entire group of endpoints that lets you to\nretrieve and manage the last run of given actor task or any of its default storages.\nAll the endpoints require an authentication token.\n\nThe base path represents the last actor task run object is:\n\n`/v2/actor-tasks/{actorTaskId}/runs/last{?token,status,origin}`\n\nUsing the `status` query parameter you can ensure to only get a run with a certain status\n(e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means\nby which they were started (e.g. `origin=API`). The output of this endpoint and other query\nparameters are the same as in the [Run object](/api/v2/actor-run-get) endpoint.\n\n##### Convenience endpoints for last Actor task run\n\n* [Dataset](/api/v2/last-actor-task-runs-default-dataset)\n\n* [Key-value store](/api/v2/last-actor-task-runs-default-key-value-store)\n\n* [Request queue](/api/v2/last-actor-task-runs-default-request-queue)\n\n* [Log](/api/v2/last-actor-task-runs-log)\n",
"operationId": "actorTask_runs_last_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/waitForFinishRun"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Run"
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-tasks/last-run-object-and-its-storages"
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/log": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2017-07-14T06:00:49.733Z Application started.\n2017-07-14T06:00:49.741Z Input: { test: 123 }\n2017-07-14T06:00:49.752Z Some useful debug information follows.\n"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's log"
],
"summary": "Get last Actor task run's log",
"description": "Retrieves last Actor task run's logs.\n\nThis endpoint is a shortcut for getting last Actor task run's log. Same as [Get log](/api/v2/log-get) endpoint.\n",
"operationId": "actorTask_last_log_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/stream"
},
{
"$ref": "#/components/parameters/download"
},
{
"$ref": "#/components/parameters/raw"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/abort": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
},
"example": {
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "BPWZBd7Z9c746JAng",
"actorTaskId": "rANaydYhUxjsnA3oz",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "ABORTED",
"statusMessage": "Actor was aborted",
"isStatusMessageTerminal": true,
"meta": {
"origin": "WEB",
"clientIp": "172.234.12.34",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"inputBodyLen": 240,
"migrationCount": 0,
"restartCount": 0,
"resurrectCount": 1,
"memAvgBytes": 35914228.4,
"memMaxBytes": 38244352,
"memCurrentBytes": 0,
"cpuAvgUsage": 0.00955965,
"cpuMaxUsage": 3.1546,
"cpuCurrentUsage": 0,
"netRxBytes": 2652,
"netTxBytes": 1338,
"durationMillis": 26239,
"runTimeSecs": 26.239,
"metamorph": 0,
"computeUnits": 0.0072886
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"buildId": "7sT5jcggjjA9fNcxF",
"exitCode": 0,
"generalAccess": "RESTRICTED",
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"storageIds": {
"datasets": {
"default": "wmKPijuyDnPZAPRMk"
},
"keyValueStores": {
"default": "eJNzqsbPiopwJcgGQ"
},
"requestQueues": {
"default": "FL35cSF7jrxr3BY39"
}
},
"isContainerServerReady": false,
"gitBranchName": "master",
"usage": {
"ACTOR_COMPUTE_UNITS": 3,
"DATASET_READS": 4,
"DATASET_WRITES": 4,
"KEY_VALUE_STORE_READS": 5,
"KEY_VALUE_STORE_WRITES": 3,
"KEY_VALUE_STORE_LISTS": 5,
"REQUEST_QUEUE_READS": 2,
"REQUEST_QUEUE_WRITES": 1,
"DATA_TRANSFER_INTERNAL_GBYTES": 1,
"DATA_TRANSFER_EXTERNAL_GBYTES": 3,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
"PROXY_SERPS": 3
},
"usageTotalUsd": 0.2654,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.072,
"DATASET_READS": 0.0004,
"DATASET_WRITES": 0.0002,
"KEY_VALUE_STORE_READS": 0.0006,
"KEY_VALUE_STORE_WRITES": 0.002,
"KEY_VALUE_STORE_LISTS": 0.004,
"REQUEST_QUEUE_READS": 0.005,
"REQUEST_QUEUE_WRITES": 0.02,
"DATA_TRANSFER_INTERNAL_GBYTES": 0.0004,
"DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16,
"PROXY_SERPS": 0.0006
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's abort"
],
"summary": "Abort Actor task's last run",
"description": "Aborts the last run of the specified Actor task and returns an object that\ncontains all the details about the run.\n\nThis endpoint is a shortcut for [Abort run](#/reference/actor-runs/abort-run/abort-run)\non the Actor task's last run. Only runs that are starting or running are aborted.\nFor runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call\ndoes nothing.\n",
"operationId": "actorTask_runs_last_abort_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/gracefully"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/metamorph": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's metamorph"
],
"summary": "Metamorph Actor task's last run",
"description": "Transforms the last run of the specified Actor task into a run of another Actor with\na new input.\n\nThis endpoint is a shortcut for [Metamorph run](#/reference/actor-runs/metamorph-run/metamorph-run)\non the Actor task's last run.\n",
"operationId": "actorTask_runs_last_metamorph_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/targetActorId"
},
{
"name": "build",
"in": "query",
"description": "Optional build of the target Actor.\n\nIt can be either a build tag or build number. By default, the run uses\nthe build specified in the default run configuration for the target\nActor (typically `latest`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "beta"
}
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/reboot": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's reboot"
],
"summary": "Reboot Actor task's last run",
"description": "Reboots the last run of the specified Actor task and returns an object that\ncontains all the details about the rebooted run.\n\nThis endpoint is a shortcut for [Reboot run](#/reference/actor-runs/reboot-run/reboot-run)\non the Actor task's last run. Only runs with status `RUNNING` can be rebooted. The run's\ncontainer will be restarted, so any data not persisted in the key-value store, dataset,\nor request queue will be lost.\n",
"operationId": "actorTask_runs_last_reboot_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/dataset": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Get last task run's default dataset",
"description": "Returns the default dataset associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the\n[Get dataset](/api/v2/dataset-get) endpoint.\n",
"operationId": "actorTask_runs_last_dataset_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Update last task run's default dataset",
"description": "Updates the default dataset associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the\n[Update dataset](/api/v2/dataset-put) endpoint.\n",
"operationId": "actorTask_runs_last_dataset_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Delete last task run's default dataset",
"description": "Deletes the default dataset associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultDatasetId` and then using the\n[Delete dataset](/api/v2/dataset-delete) endpoint.\n",
"operationId": "actorTask_runs_last_dataset_delete"
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/dataset/items": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"foo": "bar"
},
{
"foo2": "bar2"
}
]
}
},
"application/jsonl": {
"schema": {
"type": "string"
},
"example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n"
},
"text/csv": {
"schema": {
"type": "string"
},
"example": "foo,bar\\nfoo2,bar2\\n"
},
"text/html": {
"schema": {
"type": "string"
},
"example": ""
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string"
}
},
"application/rss+xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
},
"application/xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default dataset"
],
"summary": "Get last task run's dataset items",
"description": "Returns data stored in the default dataset of the last Actor task run in the desired format.\n\nThis endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the\n[Get dataset items](/api/v2/dataset-items-get) endpoint.\n",
"operationId": "actorTask_runs_last_dataset_items_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
},
{
"$ref": "#/components/parameters/signature"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PutItemsRequest"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PutItemsRequest"
}
}
],
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
}
}
}
},
"400": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/PutItemResponseError"
},
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default dataset"
],
"summary": "Store items in last task run's dataset",
"description": "Appends an item or an array of items to the end of the last Actor task run's default dataset.\n\nThis endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the\n[Store items](/api/v2/dataset-items-post) endpoint.\n\nTo save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.\n\nBelow is a list of supported `Content-Encoding` types.\n\n* Brotli: `Content-Encoding: br`\n* Gzip: `Content-Encoding: gzip`\n* Deflate: `Content-Encoding: deflate`\n",
"operationId": "actorTask_runs_last_dataset_items_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/dataset/statistics": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetStatisticsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"tags": [
"Last Actor task run's default dataset"
],
"summary": "Get last task run's dataset statistics",
"description": "Returns statistics for the last Actor task run's default dataset.\n\nThis endpoint is a shortcut that resolves the last task run's `defaultDatasetId` and proxies to the\n[Get dataset statistics](/api/v2/dataset-statistics-get) endpoint.\n",
"operationId": "actorTask_runs_last_dataset_statistics_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Get last task run's default store",
"description": "Gets an object that contains all the details about the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Get store](/api/v2/key-value-store-get) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStoreRequest"
},
"example": {
"name": "new-store-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Update last task run's default store",
"description": "Updates the default key-value store associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Update store](/api/v2/key-value-store-put) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Delete last task run's default store",
"description": "Deletes the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Delete store](/api/v2/key-value-store-delete) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_delete"
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/keys": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfKeysResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"summary": "Get last task run's default store's list of keys",
"description": "Returns a list of keys for the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Get list of keys](/api/v2/key-value-store-keys-get) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_keys_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/exclusiveStartKey"
},
{
"$ref": "#/components/parameters/limit-3"
},
{
"$ref": "#/components/parameters/collectionKeys"
},
{
"$ref": "#/components/parameters/prefixKeys"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records": {
"get": {
"responses": {
"200": {
"description": "A ZIP archive containing the requested records.",
"headers": {},
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"summary": "Download last task run's default store's records",
"description": "Downloads all records from the default key-value store of the last Actor task run as a ZIP archive.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Download records](/api/v2/key-value-store-records-get) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_records_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/collectionRecords"
},
{
"$ref": "#/components/parameters/prefixRecords"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
},
"*/*": {
"schema": {}
}
}
},
"302": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC"
}
}
}
},
"content": {}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"summary": "Get last task run's default store's record",
"description": "Gets a value stored under a specific key in the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Get record](/api/v2/key-value-store-record-get) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_record_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/signature"
},
{
"$ref": "#/components/parameters/attachment-2"
}
]
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"summary": "Store record in last task run's default store",
"description": "Stores a value under a specific key in the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Store record](/api/v2/key-value-store-record-put) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_record_put",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"summary": "Store record in last task run's default store (POST)",
"description": "Stores a value under a specific key in the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Store record](/api/v2/key-value-store-record-post) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_record_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default key-value store"
],
"summary": "Delete last task run's default store's record",
"description": "Removes a record specified by a key from the default key-value store of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultKeyValueStoreId` and then using the\n[Delete record](/api/v2/key-value-store-record-delete) endpoint.\n",
"operationId": "actorTask_runs_last_keyValueStore_record_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/recordKey"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Get last task run's default request queue",
"description": "Returns the default request queue associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Get request queue](/api/v2/request-queue-get) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateRequestQueueRequest"
},
{
"example": {
"name": "new-request-queue-name"
}
}
]
},
"example": {
"name": "new-request-queue-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Update last task run's default request queue",
"description": "Updates the default request queue associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Update request queue](/api/v2/request-queue-put) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
}
],
"summary": "Delete last task run's default request queue",
"description": "Deletes the default request queue associated with the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Delete request queue](/api/v2/request-queue-delete) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_delete"
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Get last task run's default request queue head",
"description": "Returns the given number of first requests from the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Get head](/api/v2/request-queue-head-get) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_head_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/headLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head/lock": {
"post": {
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadAndLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Get and lock last task run's default request queue head",
"description": "Returns the given number of first requests from the default request queue of the last Actor task run\nand locks them for the given time.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Get head and lock](/api/v2/request-queue-head-lock-post) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_head_lock_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/headLockLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "List last task run's default request queue's requests",
"description": "Returns a list of requests from the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[List requests](/api/v2/request-queue-requests-get) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_requests_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/exclusiveStartId"
},
{
"$ref": "#/components/parameters/listLimit"
},
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/filter"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Add request to last task run's default request queue",
"description": "Adds a request to the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Add request](/api/v2/request-queue-requests-post) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_requests_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/batch": {
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestWithoutId"
},
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchAddResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Batch add requests to last task run's default request queue",
"description": "Adds requests to the default request queue of the last Actor task run in batch.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Add requests](/api/v2/request-queue-requests-batch-post) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_requests_batch_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
]
},
"delete": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestDraftDelete"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDeleteResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Batch delete requests from last task run's default request queue",
"description": "Batch-deletes requests from the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Delete requests](/api/v2/request-queue-requests-batch-delete) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_requests_batch_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/contentTypeJson"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/unlock": {
"post": {
"responses": {
"200": {
"description": "Number of requests that were unlocked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Unlock requests in last task run's default request queue",
"description": "Unlocks requests in the default request queue of the last Actor task run that are currently locked by the client.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Unlock requests](/api/v2/request-queue-requests-unlock-post) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_requests_unlock_post",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Get request from last task run's default request queue",
"description": "Returns a request from the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Get request](/api/v2/request-queue-request-get) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_request_get",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
}
]
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Update request in last task run's default request queue",
"description": "Updates a request in the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Update request](/api/v2/request-queue-request-put) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_request_put",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/forefront"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Delete request from last task run's default request queue",
"description": "Deletes a request from the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Delete request](/api/v2/request-queue-request-delete) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_request_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}/lock": {
"put": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProlongRequestLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Prolong lock on request in last task run's default request queue",
"description": "Prolongs a request lock in the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_request_lock_put",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/lockForefront"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Last Actor task run's default request queue"
],
"summary": "Delete lock on request in last task run's default request queue",
"description": "Deletes a request lock in the default request queue of the last Actor task run.\n\nThis endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the\n[Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint.\n",
"operationId": "actorTask_runs_last_requestQueue_request_lock_delete",
"parameters": [
{
"$ref": "#/components/parameters/actorTaskId"
},
{
"$ref": "#/components/parameters/status-2"
},
{
"$ref": "#/components/parameters/origin"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/deleteForefront"
}
]
}
},
"/v2/actor-runs": {
"get": {
"tags": [
"Actor runs"
],
"summary": "Get user runs list",
"description": "Gets a list of all runs for a user. The response is a list of objects, where\neach object contains basic information about a single Actor run.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 array elements.\n\nBy default, the records are sorted by the `startedAt` field in ascending\norder. Therefore, you can use pagination to incrementally fetch all records while\nnew ones are still being created. To sort the records in descending order, use\n`desc=1` parameter. You can also filter runs by `startedAt`` and `status`` fields ([available\nstatuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)).\n",
"operationId": "actorRuns_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descStartedAt"
},
{
"$ref": "#/components/parameters/status"
},
{
"$ref": "#/components/parameters/startedAfter"
},
{
"$ref": "#/components/parameters/startedBefore"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOfRunsResponse"
}
]
},
"examples": {
"example": {
"$ref": "#/components/examples/ListOfRunsResponseExample"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list",
"https://docs.apify.com/api/v2#/reference/actor-runs/get-user-runs-list",
"https://docs.apify.com/api/v2#tag/Actor-runsRun-collection/operation/actorRuns_get"
]
}
},
"/v2/actor-runs/{runId}": {
"get": {
"tags": [
"Actor runs"
],
"summary": "Get run",
"description": "This is not a single endpoint, but an entire group of endpoints that lets\nyou retrieve the run or any of its default storages.\n\n##### Convenience endpoints for Actor run default storages\n\n* [Dataset](/api/v2/default-dataset)\n\n* [Key-value store](/api/v2/default-key-value-store)\n\n* [Request queue](/api/v2/default-request-queue)\n\nGets an object that contains all the details about a\nspecific run of an Actor.\n\nBy passing the optional `waitForFinish` parameter the API endpoint will synchronously wait\nfor the run to finish. This is useful to avoid periodic polling when waiting for Actor run to complete.\nNote that the first response after completion can still show preliminary `stats`, costs, and event counts.\nFor stable figures, wait about 10 seconds and call the endpoint again.\n\nThis endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However,\nif you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.\n",
"operationId": "actorRun_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/waitForFinishRun"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RunResponse"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/run-object-and-its-storages/get-run",
"https://docs.apify.com/api/v2#/reference/actor-runs/get-run",
"https://docs.apify.com/api/v2#tag/Actor-runsRun-object-and-its-storages/operation/actorRun_get"
]
},
"put": {
"tags": [
"Actor runs"
],
"summary": "Update run",
"description": "This endpoint can be used to update both the run's status message and to configure its general resource access level.\n\n**Status message:**\n\nYou can set a single status message on your run that will be displayed in\nthe Apify Console UI. During an Actor run, you will typically do this in order\nto inform users of your Actor about the Actor's progress.\n\nThe request body must contain `runId` and `statusMessage` properties. The\n`isStatusMessageTerminal` property is optional and it indicates if the\nstatus message is the very last one. In the absence of a status message, the\nplatform will try to substitute sensible defaults.\n\n**General resource access:**\n\nYou can also update the run's general resource access setting, which determines who can view the run and its related data.\n\nAllowed values:\n\n* `FOLLOW_USER_SETTING` - The run inherits the general access setting from the account level.\n* `ANYONE_WITH_ID_CAN_READ` - The run can be viewed anonymously by anyone who has its ID.\n* `RESTRICTED` - Only users with explicit access to the resource can access the run.\n\nWhen a run is accessible anonymously, all of the run's default storages and logs also become accessible anonymously.\n",
"operationId": "actorRun_put",
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateRunRequest"
},
{
"example": {
"runId": "3KH8gEpp4d8uQSe8T",
"statusMessage": "Actor has finished",
"isStatusMessageTerminal": true
}
}
]
},
"example": {
"runId": "3KH8gEpp4d8uQSe8T",
"statusMessage": "Actor has finished",
"isStatusMessageTerminal": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/update-status-message/update-status-message",
"https://docs.apify.com/api/v2#/reference/actor-runs/update-status-message",
"https://docs.apify.com/api/v2#tag/Actor-runsUpdate-status-message/operation/actorRun_put"
]
},
"delete": {
"tags": [
"Actor runs"
],
"summary": "Delete run",
"description": "Delete the run. Only finished runs can be deleted. Only the person or\norganization that initiated the run can delete it.\n",
"operationId": "actorRun_delete",
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run",
"https://docs.apify.com/api/v2#/reference/actor-runs/delete-run",
"https://docs.apify.com/api/v2#tag/Actor-runsDelete-run/operation/actorRun_delete"
],
"x-js-parent": "RunClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#delete"
}
},
"/v2/actor-runs/{runId}/abort": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
},
"example": {
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "BPWZBd7Z9c746JAng",
"actorTaskId": "rANaydYhUxjsnA3oz",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "ABORTED",
"statusMessage": "Actor was aborted",
"isStatusMessageTerminal": true,
"meta": {
"origin": "WEB",
"clientIp": "172.234.12.34",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"inputBodyLen": 240,
"migrationCount": 0,
"restartCount": 0,
"resurrectCount": 1,
"memAvgBytes": 35914228.4,
"memMaxBytes": 38244352,
"memCurrentBytes": 0,
"cpuAvgUsage": 0.00955965,
"cpuMaxUsage": 3.1546,
"cpuCurrentUsage": 0,
"netRxBytes": 2652,
"netTxBytes": 1338,
"durationMillis": 26239,
"runTimeSecs": 26.239,
"metamorph": 0,
"computeUnits": 0.0072886
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"buildId": "7sT5jcggjjA9fNcxF",
"exitCode": 0,
"generalAccess": "RESTRICTED",
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"storageIds": {
"datasets": {
"default": "wmKPijuyDnPZAPRMk"
},
"keyValueStores": {
"default": "eJNzqsbPiopwJcgGQ"
},
"requestQueues": {
"default": "FL35cSF7jrxr3BY39"
}
},
"isContainerServerReady": false,
"gitBranchName": "master",
"usage": {
"ACTOR_COMPUTE_UNITS": 3,
"DATASET_READS": 4,
"DATASET_WRITES": 4,
"KEY_VALUE_STORE_READS": 5,
"KEY_VALUE_STORE_WRITES": 3,
"KEY_VALUE_STORE_LISTS": 5,
"REQUEST_QUEUE_READS": 2,
"REQUEST_QUEUE_WRITES": 1,
"DATA_TRANSFER_INTERNAL_GBYTES": 1,
"DATA_TRANSFER_EXTERNAL_GBYTES": 3,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
"PROXY_SERPS": 3
},
"usageTotalUsd": 0.2654,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.072,
"DATASET_READS": 0.0004,
"DATASET_WRITES": 0.0002,
"KEY_VALUE_STORE_READS": 0.0006,
"KEY_VALUE_STORE_WRITES": 0.002,
"KEY_VALUE_STORE_LISTS": 0.004,
"REQUEST_QUEUE_READS": 0.005,
"REQUEST_QUEUE_WRITES": 0.02,
"DATA_TRANSFER_INTERNAL_GBYTES": 0.0004,
"DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16,
"PROXY_SERPS": 0.0006
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actor runs"
],
"summary": "Abort run",
"description": "Aborts an Actor run and returns an object that contains all the details\nabout the run.\n\nOnly runs that are starting or running are aborted. For runs with status\n`FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.\n",
"operationId": "actorRun_abort_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/gracefully"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run",
"https://docs.apify.com/api/v2#/reference/actor-runs/abort-run",
"https://docs.apify.com/api/v2#tag/Actor-runsAbort-run/operation/actorRun_abort_post"
],
"x-js-parent": "RunClient",
"x-js-name": "abort",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#abort",
"x-py-parent": "RunClientAsync",
"x-py-name": "abort",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#abort"
}
},
"/v2/actor-runs/{runId}/metamorph": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actor runs"
],
"summary": "Metamorph run",
"description": "Transforms an Actor run into a run of another Actor with a new input.\n\nThis is useful if you want to use another Actor to finish the work\nof your current Actor run, without the need to create a completely new run\nand waiting for its finish.\n\nFor the users of your Actors, the metamorph operation is transparent, they\nwill just see your Actor got the work done.\n\nInternally, the system stops the Docker container corresponding to the Actor\nrun and starts a new container using a different Docker image.\n\nAll the default storages are preserved and the new input is stored under the\n`INPUT-METAMORPH-1` key in the same default key-value store.\n\nFor more information, see the [Actor docs](https://docs.apify.com/platform/actors/development/programming-interface/metamorph).\n",
"operationId": "actorRun_metamorph_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/targetActorId"
},
{
"name": "build",
"in": "query",
"description": "Optional build of the target Actor.\n\nIt can be either a build tag or build number. By default, the run uses\nthe build specified in the default run configuration for the target\nActor (typically `latest`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "beta"
}
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run",
"https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run",
"https://docs.apify.com/api/v2#tag/Actor-runsMetamorph-run/operation/actorRun_metamorph_post"
],
"x-js-parent": "RunClient",
"x-js-name": "metamorph",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#metamorph",
"x-py-parent": "RunClientAsync",
"x-py-name": "metamorph",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#metamorph"
}
},
"/v2/actor-runs/{runId}/reboot": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actor runs"
],
"summary": "Reboot run",
"description": "Reboots an Actor run and returns an object that contains all the details\nabout the rebooted run.\n\nOnly runs that are running, i.e. runs with status `RUNNING` can be rebooted.\n\nThe run's container will be restarted, so any data not persisted in the\nkey-value store, dataset, or request queue will be lost.\n",
"operationId": "actorRun_reboot_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run",
"https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run",
"https://docs.apify.com/api/v2#tag/Actor-runsReboot-run/operation/actorRun_reboot_post"
],
"x-js-parent": "RunClient",
"x-js-name": "reboot",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#reboot",
"x-py-parent": "RunClientAsync",
"x-py-name": "reboot",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#reboot"
}
},
"/v2/actor-runs/{runId}/resurrect": {
"post": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/RunResponse"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actor runs"
],
"summary": "Resurrect run",
"description": "Resurrects a finished Actor run and returns an object that contains all the details about the resurrected run.\nOnly finished runs, i.e. runs with status `FINISHED`, `FAILED`, `ABORTED` and `TIMED-OUT` can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same storages\n(the same behaviour as when the run gets migrated to the new server).\n\nFor more information, see the [Actor docs](https://docs.apify.com/platform/actors/running/runs-and-builds#resurrection-of-finished-run).\n",
"operationId": "PostResurrectRun",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/buildResurrect"
},
{
"$ref": "#/components/parameters/timeoutResurrect"
},
{
"$ref": "#/components/parameters/memoryResurrect"
},
{
"$ref": "#/components/parameters/maxItems"
},
{
"$ref": "#/components/parameters/maxTotalChargeUsd"
},
{
"$ref": "#/components/parameters/restartOnErrorResurrect"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run",
"https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run",
"https://docs.apify.com/api/v2#tag/Actor-runsResurrect-run/operation/PostResurrectRun"
],
"x-js-parent": "RunClient",
"x-js-name": "resurrect",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#resurrect",
"x-py-parent": "RunClientAsync",
"x-py-name": "resurrect",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#resurrect"
}
},
"/v2/actor-runs/{runId}/charge": {
"post": {
"tags": [
"Actor runs"
],
"summary": "Charge events in run",
"description": "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).\nThe event you are charging for must be one of the configured events in your Actor. If the Actor is not set up as pay per event, or if the event is not configured,\nthe endpoint will return an error. The endpoint must be called from the Actor run itself, with the same API token that the run was started with.\n\n:::info Learn more about pay-per-event pricing\n\nFor more details about pay-per-event (PPE) pricing, refer to our [PPE documentation](/actors/publishing/monetize/pay-per-event).\n\n:::\n",
"operationId": "PostChargeRun",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"name": "idempotency-key",
"in": "header",
"required": true,
"schema": {
"type": "string"
},
"example": "2024-12-09T01:23:45.000Z-random-uuid",
"description": "Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors. The key expires 3 minutes after the charge, so a later request with the same key creates a new charge."
}
],
"requestBody": {
"description": "Define which event, and how many times, you want to charge for.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChargeRunRequest"
},
"example": {
"eventName": "ANALYZE_PAGE",
"count": 1
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The charge was successful. Note that you still have to make sure in your Actor that the total charge for the run respects the maximum value set by the user, as the API does not check this. Above the limit, the charges reported as successful in API will not be added to your payouts, but you will still bear the associated costs. Use the Apify charge manager or SDK to avoid having to deal with this manually.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-js-parent": "RunClient",
"x-js-name": "charge",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#charge",
"x-py-parent": "RunClientAsync",
"x-py-name": "charge",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#charge",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run",
"https://docs.apify.com/api/v2#tag/Actor-runsCharge-events-in-run/operation/PostChargeRun"
]
}
},
"/v2/actor-runs/{runId}/dataset": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Get default dataset",
"description": "Returns the default dataset associated with an Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the\n[Get dataset](/api/v2/dataset-get) endpoint.\n",
"operationId": "actorRun_dataset_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Update default dataset",
"description": "Updates the default dataset associated with an Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the\n[Put dataset](/api/v2/dataset-put) endpoint.\n",
"operationId": "actorRun_dataset_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default dataset"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Delete default dataset",
"description": "Deletes default dataset associated with an Actor run.\n\nThis endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the\n[ Delete dataset ](/api/v2/dataset-delete) endpoint.\n",
"operationId": "actorRun_dataset_delete"
}
},
"/v2/actor-runs/{runId}/dataset/items": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"foo": "bar"
},
{
"foo2": "bar2"
}
]
}
},
"application/jsonl": {
"schema": {
"type": "string"
},
"example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n"
},
"text/csv": {
"schema": {
"type": "string"
},
"example": "foo,bar\\nfoo2,bar2\\n"
},
"text/html": {
"schema": {
"type": "string"
},
"example": ""
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string"
}
},
"application/rss+xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
},
"application/xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default dataset"
],
"summary": "Get default dataset items",
"description": "Returns data stored in the default dataset of the Actor run in the desired format.\n\nThis endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the\n[Get dataset items](/api/v2/dataset-items-get) endpoint.\n",
"operationId": "actorRun_dataset_items_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
},
{
"$ref": "#/components/parameters/signature"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PutItemsRequest"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PutItemsRequest"
}
}
],
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
}
}
}
},
"400": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/PutItemResponseError"
},
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default dataset"
],
"summary": "Store items",
"description": "Appends an item or an array of items to the end of the Actor run's default dataset.\n\nThis endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the\n[Store items](/api/v2/dataset-items-post) endpoint.\n\nTo save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.\n\nBelow is a list of supported `Content-Encoding` types.\n\n* Brotli: `Content-Encoding: br`\n* Gzip: `Content-Encoding: gzip`\n* Deflate: `Content-Encoding: deflate`\n",
"operationId": "actorRun_dataset_items_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
}
},
"/v2/actor-runs/{runId}/dataset/statistics": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetStatisticsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"tags": [
"Default dataset"
],
"summary": "Get default dataset statistics",
"description": "Returns statistics for the Actor run's default dataset.\n\nThis endpoint is a shortcut that resolves the run's `defaultDatasetId` and proxies to the\n[Get dataset statistics](/api/v2/dataset-statistics-get) endpoint.\n",
"operationId": "actorRun_dataset_statistics_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
]
}
},
"/v2/actor-runs/{runId}/key-value-store": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Get default store",
"description": "Gets an object that contains all the details about the default key-value\nstore.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Get store](/api/v2/key-value-store-get) endpoint.\n",
"operationId": "actorRun_keyValueStore_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStoreRequest"
},
"example": {
"name": "new-store-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Update default store",
"description": "Updates the default key-value store's name and general resource access level using a value specified by a JSON object\npassed in the PUT payload.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Update store](/api/v2/key-value-store-put) endpoint.\n",
"operationId": "actorRun_keyValueStore_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Delete default store",
"description": "Delete the default key-value store.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Delete store](/api/v2/key-value-store-delete) endpoint.\n",
"operationId": "actorRun_keyValueStore_delete"
}
},
"/v2/actor-runs/{runId}/key-value-store/keys": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfKeysResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"summary": "Get default store's list of keys",
"description": "Returns a list of keys for the default key-value store of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Get list of keys](/api/v2/key-value-store-keys-get) endpoint.\n",
"operationId": "actorRun_keyValueStore_keys_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/exclusiveStartKey"
},
{
"$ref": "#/components/parameters/limit-3"
},
{
"$ref": "#/components/parameters/collectionKeys"
},
{
"$ref": "#/components/parameters/prefixKeys"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/actor-runs/{runId}/key-value-store/records": {
"get": {
"responses": {
"200": {
"description": "A ZIP archive containing the requested records.",
"headers": {},
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"summary": "Download default store's records",
"description": "Downloads all records from the default key-value store of the Actor run as a ZIP archive.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Download records](/api/v2/key-value-store-records-get) endpoint.\n",
"operationId": "actorRun_keyValueStore_records_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/collectionRecords"
},
{
"$ref": "#/components/parameters/prefixRecords"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/actor-runs/{runId}/key-value-store/records/{recordKey}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
},
"*/*": {
"schema": {}
}
}
},
"302": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC"
}
}
}
},
"content": {}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"summary": "Get default store's record",
"description": "Gets a value stored under a specific key in the default key-value store of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Get record](/api/v2/key-value-store-record-get) endpoint.\n",
"operationId": "actorRun_keyValueStore_record_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/signature"
},
{
"$ref": "#/components/parameters/attachment-2"
}
]
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"summary": "Store record in default store",
"description": "Stores a value under a specific key in the default key-value store of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Store record](/api/v2/key-value-store-record-put) endpoint.\n",
"operationId": "actorRun_keyValueStore_record_put",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"summary": "Store record in default store (POST)",
"description": "Stores a value under a specific key in the default key-value store of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Store record](/api/v2/key-value-store-record-post) endpoint.\n",
"operationId": "actorRun_keyValueStore_record_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default key-value store"
],
"summary": "Delete default store's record",
"description": "Removes a record specified by a key from the default key-value store of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultKeyValueStoreId` and then using the\n[Delete record](/api/v2/key-value-store-record-delete) endpoint.\n",
"operationId": "actorRun_keyValueStore_record_delete",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/recordKey"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Get default request queue",
"description": "Returns the default request queue associated with an Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Get request queue](/api/v2/request-queue-get) endpoint.\n",
"operationId": "actorRun_requestQueue_get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateRequestQueueRequest"
},
{
"example": {
"name": "new-request-queue-name"
}
}
]
},
"example": {
"name": "new-request-queue-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Update default request queue",
"description": "Updates the default request queue associated with an Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Update request queue](/api/v2/request-queue-put) endpoint.\n",
"operationId": "actorRun_requestQueue_put"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"parameters": [
{
"$ref": "#/components/parameters/runId"
}
],
"summary": "Delete default request queue",
"description": "Deletes the default request queue associated with an Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Delete request queue](/api/v2/request-queue-delete) endpoint.\n",
"operationId": "actorRun_requestQueue_delete"
}
},
"/v2/actor-runs/{runId}/request-queue/requests": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "List default request queue's requests",
"description": "Returns a list of requests from the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[List requests](/api/v2/request-queue-requests-get) endpoint.\n",
"operationId": "actorRun_requestQueue_requests_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/exclusiveStartId"
},
{
"$ref": "#/components/parameters/listLimit"
},
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/filter"
}
]
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Add request to default request queue",
"description": "Adds a request to the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Add request](/api/v2/request-queue-requests-post) endpoint.\n",
"operationId": "actorRun_requestQueue_requests_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue/requests/batch": {
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestWithoutId"
},
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchAddResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Batch add requests to default request queue",
"description": "Adds requests to the default request queue of the Actor run in batch.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Add requests](/api/v2/request-queue-requests-batch-post) endpoint.\n",
"operationId": "actorRun_requestQueue_requests_batch_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
]
},
"delete": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestDraftDelete"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDeleteResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Batch delete requests from default request queue",
"description": "Batch-deletes requests from the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Delete requests](/api/v2/request-queue-requests-batch-delete) endpoint.\n",
"operationId": "actorRun_requestQueue_requests_batch_delete",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/contentTypeJson"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue/requests/unlock": {
"post": {
"responses": {
"200": {
"description": "Number of requests that were unlocked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Unlock requests in default request queue",
"description": "Unlocks requests in the default request queue of the Actor run that are currently locked by the client.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Unlock requests](/api/v2/request-queue-requests-unlock-post) endpoint.\n",
"operationId": "actorRun_requestQueue_requests_unlock_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue/requests/{requestId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Get request from default request queue",
"description": "Returns a request from the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Get request](/api/v2/request-queue-request-get) endpoint.\n",
"operationId": "actorRun_requestQueue_request_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/requestId"
}
]
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Update request in default request queue",
"description": "Updates a request in the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Update request](/api/v2/request-queue-request-put) endpoint.\n",
"operationId": "actorRun_requestQueue_request_put",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/forefront"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Delete request from default request queue",
"description": "Deletes a request from the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Delete request](/api/v2/request-queue-request-delete) endpoint.\n",
"operationId": "actorRun_requestQueue_request_delete",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue/requests/{requestId}/lock": {
"put": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProlongRequestLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Prolong lock on request in default request queue",
"description": "Prolongs a request lock in the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint.\n",
"operationId": "actorRun_requestQueue_request_lock_put",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/lockForefront"
}
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Delete lock on request in default request queue",
"description": "Deletes a request lock in the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint.\n",
"operationId": "actorRun_requestQueue_request_lock_delete",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/deleteForefront"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue/head": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Get default request queue head",
"description": "Returns the given number of first requests from the default request queue of the Actor run.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Get head](/api/v2/request-queue-head-get) endpoint.\n",
"operationId": "actorRun_requestQueue_head_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/headLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-runs/{runId}/request-queue/head/lock": {
"post": {
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadAndLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Default request queue"
],
"summary": "Get and lock default request queue head",
"description": "Returns the given number of first requests from the default request queue of the Actor run\nand locks them for the given time.\n\nThis endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the\n[Get head and lock](/api/v2/request-queue-head-lock-post) endpoint.\n",
"operationId": "actorRun_requestQueue_head_lock_post",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/headLockLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
]
}
},
"/v2/actor-runs/{runId}/log": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2017-07-14T06:00:49.733Z Application started.\n2017-07-14T06:00:49.741Z Input: { test: 123 }\n2017-07-14T06:00:49.752Z Some useful debug information follows.\n"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actor runs"
],
"summary": "Get run's log",
"description": "Retrieves Actor run's logs.\n\nThis endpoint is a shortcut for getting the run's log. Same as [Get log](/api/v2/log-get) endpoint.\n",
"operationId": "actorRun_log_get",
"parameters": [
{
"$ref": "#/components/parameters/runId"
},
{
"$ref": "#/components/parameters/stream"
},
{
"$ref": "#/components/parameters/download"
},
{
"$ref": "#/components/parameters/raw"
}
]
}
},
"/v2/actor-builds": {
"get": {
"tags": [
"Actor builds"
],
"summary": "Get user builds list",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list",
"https://docs.apify.com/api/v2#/reference/actor-builds/get-user-builds-list",
"https://docs.apify.com/api/v2#tag/Actor-buildsBuild-collection/operation/actorBuilds_get"
],
"description": "Gets a list of all builds for a user. The response is a JSON array of\nobjects, where each object contains basic information about a single build.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\n\nBy default, the records are sorted by the `startedAt` field in ascending\norder. Therefore, you can use pagination to incrementally fetch all builds while\nnew ones are still being started. To sort the records in descending order, use\nthe `desc=1` parameter.\n",
"operationId": "actorBuilds_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descStartedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfBuildsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false
}
},
"/v2/actor-builds/{buildId}": {
"get": {
"tags": [
"Actor builds"
],
"summary": "Get build",
"description": "Gets an object that contains all the details about a specific build of an\nActor.\n\nBy passing the optional `waitForFinish` parameter the API endpoint will\nsynchronously wait for the build to finish. This is useful to avoid periodic\npolling when waiting for an Actor build to finish.\n\nThis endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the build. However,\nif you access the endpoint without the token, certain attributes, such as `usageUsd` and `usageTotalUsd`, will be hidden.\n",
"operationId": "actorBuild_get",
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/buildId"
},
{
"$ref": "#/components/parameters/waitForFinishBuild"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BuildResponse"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"408": {
"$ref": "#/components/responses/Timeout"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build",
"https://docs.apify.com/api/v2#/reference/actor-builds/get-build",
"https://docs.apify.com/api/v2#tag/Actor-buildsBuild-object/operation/actorBuild_get"
],
"x-js-parent": "BuildClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#get",
"x-py-parent": "BuildClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildClientAsync#get"
},
"delete": {
"tags": [
"Actor builds"
],
"summary": "Delete build",
"description": "Delete the build. The build that is the current default build for the Actor\ncannot be deleted.\n\nOnly users with build permissions for the Actor can delete builds.\n",
"operationId": "actorBuild_delete",
"parameters": [
{
"$ref": "#/components/parameters/buildId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build",
"https://docs.apify.com/api/v2#/reference/actor-builds/delete-build",
"https://docs.apify.com/api/v2#tag/Actor-builds/operation/actorBuild_delete"
],
"x-js-parent": "BuildClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#delete"
}
},
"/v2/actor-builds/{buildId}/abort": {
"post": {
"tags": [
"Actor builds"
],
"summary": "Abort build",
"description": "Aborts an Actor build and returns an object that contains all the details\nabout the build.\n\nOnly builds that are starting or running are aborted. For builds with status\n`FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call does nothing.\n",
"operationId": "actorBuild_abort_post",
"parameters": [
{
"$ref": "#/components/parameters/buildId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BuildResponse"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build",
"https://docs.apify.com/api/v2#/reference/actor-builds/abort-build",
"https://docs.apify.com/api/v2#tag/Actor-buildsAbort-build/operation/actorBuild_abort_post"
],
"x-js-parent": "BuildClient",
"x-js-name": "abort",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#abort",
"x-py-parent": "BuildClientAsync",
"x-py-name": "abort",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildClientAsync#abort"
}
},
"/v2/actor-builds/{buildId}/log": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2017-07-14T06:00:49.733Z Application started.\n2017-07-14T06:00:49.741Z Input: { test: 123 }\n2017-07-14T06:00:49.752Z Some useful debug information follows.\n"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Actor builds"
],
"summary": "Get build's Log",
"description": "Retrieves Actor build's logs.\n\nThis endpoint is a shortcut for getting the build's log. Same as [Get log](/api/v2/log-get) endpoint.\n",
"operationId": "actorBuild_log_get",
"parameters": [
{
"$ref": "#/components/parameters/buildId"
},
{
"$ref": "#/components/parameters/stream"
},
{
"$ref": "#/components/parameters/download"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/actor-builds/build-log/get-log",
"https://docs.apify.com/api/v2#/reference/actor-builds/get-log",
"https://docs.apify.com/api/v2#tag/Actor-buildsBuild-log/operation/actorBuild_log_get"
]
}
},
"/v2/actor-builds/{buildId}/openapi.json": {
"get": {
"tags": [
"Actor builds"
],
"summary": "Get OpenAPI definition",
"description": "Get the OpenAPI definition for Actor builds. Two similar endpoints are available:\n\n- [First endpoint](/api/v2/actor-openapi-json-get): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.\n- [Second endpoint](/api/v2/actor-build-openapi-json-get): Requires only `buildId`.\n\nGet the OpenAPI definition for a specific Actor build.\nAuthentication is based on the build's unique ID. No authentication token is required.\n\n:::note\n\nYou can also use the [`/api/v2/actor-openapi-json-get`](/api/v2/actor-openapi-json-get) endpoint to get the OpenAPI definition for a build.\n\n:::\n",
"operationId": "actorBuild_openapi_json_get",
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/buildIdWithDefault"
}
],
"responses": {
"200": {
"description": "The OpenAPI specification document for the Actor build.",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "A standard OpenAPI 3.x JSON document."
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"x-js-parent": "BuildClient",
"x-js-name": "getOpenApiDefinition",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#getOpenApiDefinition",
"x-py-parent": "BuildClient",
"x-py-name": "get_open_api_definition",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildClient#get_open_api_definition"
}
},
"/v2/key-value-stores": {
"get": {
"tags": [
"Storage/Key-value stores"
],
"summary": "Get list of key-value stores",
"description": "Gets the list of key-value stores owned by the user.\n\nThe response is a list of objects, where each objects contains a basic\ninformation about a single key-value store.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 array elements.\n\nBy default, the records are sorted by the `createdAt` field in ascending\norder, therefore you can use pagination to incrementally fetch all key-value stores\nwhile new ones are still being created. To sort the records in descending order, use\nthe `desc=1` parameter.\n",
"operationId": "keyValueStores_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
},
{
"$ref": "#/components/parameters/unnamed"
},
{
"name": "ownership",
"in": "query",
"description": "Filter by ownership. If this parameter is omitted, all accessible key-value stores are returned.\n\n- `ownedByMe`: Return only key-value stores owned by the user.\n- `sharedWithMe`: Return only key-value stores shared with the user by other users.\n",
"style": "form",
"explode": true,
"schema": {
"$ref": "#/components/schemas/StorageOwnership"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfKeyValueStoresResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores",
"https://docs.apify.com/api/v2#/reference/key-value-stores/get-list-of-key-value-stores",
"https://docs.apify.com/api/v2#tag/Key-value-storesStore-collection/operation/keyValueStores_get"
],
"x-js-parent": "KeyValueStoreCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreCollectionClient#list",
"x-py-parent": "KeyValueStoreCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClientAsync#list"
},
"post": {
"tags": [
"Storage/Key-value stores"
],
"summary": "Create key-value store",
"description": "Creates a key-value store and returns its object. The response is the same\nobject as returned by the [Get store](#/reference/key-value-stores/store-object/get-store)\nendpoint.\n\nKeep in mind that data stored under unnamed store follows [data retention\nperiod](https://docs.apify.com/platform/storage#data-retention).\n\nIt creates a store with the given name if the parameter name is used.\nIf there is another store with the same name, the endpoint does not create a\nnew one and returns the existing object instead.\n",
"operationId": "keyValueStores_post",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Custom unique name to easily identify the store in the future.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "eshop-values"
}
}
],
"responses": {
"200": {
"description": "Returns the existing key-value store object if a store with the given name already exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store",
"https://docs.apify.com/api/v2#/reference/key-value-stores/create-key-value-store",
"https://docs.apify.com/api/v2#tag/Key-value-storesStore-collection/operation/keyValueStores_post"
],
"x-js-parent": "KeyValueStoreCollectionClient",
"x-js-name": "getOrCreate",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreCollectionClient#getOrCreate",
"x-py-parent": "KeyValueStoreCollectionClientAsync",
"x-py-name": "get_or_create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClientAsync#get_or_create"
}
},
"/v2/key-value-stores/{storeId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"parameters": [
{
"$ref": "#/components/parameters/storeId"
}
],
"summary": "Get store",
"description": "Gets an object that contains all the details about a specific key-value\nstore.\n",
"operationId": "keyValueStore_get",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store",
"https://docs.apify.com/api/v2#/reference/key-value-stores/get-store",
"https://docs.apify.com/api/v2#tag/Key-value-storesStore-object/operation/keyValueStore_get"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#get",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStoreRequest"
},
"example": {
"name": "new-store-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyValueStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"parameters": [
{
"$ref": "#/components/parameters/storeId"
}
],
"summary": "Update store",
"description": "Updates a key-value store's name and general resource access level using a value specified by a JSON object\npassed in the PUT payload.\n\nThe response is the updated key-value store object, as returned by the [Get\nstore](#/reference/key-value-stores/store-object/get-store) API endpoint.\n",
"operationId": "keyValueStore_put",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store",
"https://docs.apify.com/api/v2#/reference/key-value-stores/update-store",
"https://docs.apify.com/api/v2#tag/Key-value-storesStore-object/operation/keyValueStore_put"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#update",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#update"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"parameters": [
{
"$ref": "#/components/parameters/storeId"
}
],
"summary": "Delete store",
"description": "Deletes a key-value store.",
"operationId": "keyValueStore_delete",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store",
"https://docs.apify.com/api/v2#/reference/key-value-stores/delete-store",
"https://docs.apify.com/api/v2#tag/Key-value-storesStore-object/operation/keyValueStore_delete"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#delete"
}
},
"/v2/key-value-stores/{storeId}/keys": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfKeysResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"summary": "Get list of keys",
"description": "Returns a list of objects describing keys of a given key-value store, as\nwell as some information about the values (e.g. size).\n\nThis endpoint is paginated using `exclusiveStartKey` and `limit` parameters\n- see [Pagination](/api/v2#using-key) for more details.\n",
"operationId": "keyValueStore_keys_get",
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/exclusiveStartKey"
},
{
"$ref": "#/components/parameters/limit-3"
},
{
"$ref": "#/components/parameters/collectionKeys"
},
{
"$ref": "#/components/parameters/prefixKeys"
},
{
"$ref": "#/components/parameters/signature"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys",
"https://docs.apify.com/api/v2#/reference/key-value-stores/get-list-of-keys",
"https://docs.apify.com/api/v2#tag/Key-value-storesKey-collection/operation/keyValueStore_keys_get"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "listKeys",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#listKeys",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "list_keys",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#list_keys"
}
},
"/v2/key-value-stores/{storeId}/records": {
"get": {
"responses": {
"200": {
"description": "A ZIP archive containing the requested records.",
"headers": {},
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"summary": "Download records",
"description": "Downloads all records from the key-value store as a ZIP archive.\nEach record is stored as a separate file in the archive, with the filename equal to the record key.\n\nYou can optionally filter the records by `collection` or `prefix` to download only a subset of the store.\n",
"operationId": "keyValueStore_records_get",
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/collectionRecords"
},
{
"$ref": "#/components/parameters/prefixRecords"
},
{
"$ref": "#/components/parameters/signature"
}
]
}
},
"/v2/key-value-stores/{storeId}/records/{recordKey}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
},
"*/*": {
"schema": {}
}
}
},
"302": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC"
}
}
}
},
"content": {}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"summary": "Get record",
"description": "Gets a value stored in the key-value store under a specific key.\n\nThe response body has the same `Content-Encoding` header as it was set in\n[Put record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put).\n\nIf the request does not define the `Accept-Encoding` HTTP header with the\nright encoding, the record will be decompressed.\n\nMost HTTP clients support decompression by default. After using the HTTP\nclient with decompression support, the `Accept-Encoding` header is set by\nthe client and body is decompressed automatically.\n\nPlease note that for security reasons, Apify API can perform small modifications\nto HTML documents before they are served via this endpoint. To fetch the raw HTML\ncontent without any modifications, use the `attachment` query parameter.\n",
"operationId": "keyValueStore_record_get",
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/attachment-2"
},
{
"$ref": "#/components/parameters/signature"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record",
"https://docs.apify.com/api/v2#/reference/key-value-stores/get-record",
"https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_get"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "getRecord",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#getRecord",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "get_record",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#get_record"
},
"head": {
"tags": [
"Storage/Key-value stores"
],
"summary": "Check if a record exists",
"description": "Check if a value is stored in the key-value store under a specific key.\n",
"operationId": "keyValueStore_record_head",
"responses": {
"200": {
"description": "The record exists",
"headers": {}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/recordKey"
}
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "recordExists",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#recordExists",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "record_exists",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#record_exists"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"summary": "Store record",
"description": "Stores a value under a specific key to the key-value store.\n\nThe value is passed as the PUT payload and it is stored with a MIME content\ntype defined by the `Content-Type` header and with encoding defined by the\n`Content-Encoding` header.\n\nTo save bandwidth, storage, and speed up your upload, send the request\npayload compressed with Gzip compression and add the `Content-Encoding: gzip`\nheader. It is possible to set up another compression type with `Content-Encoding`\nrequest header.\n\nBelow is a list of supported `Content-Encoding` types.\n\n* Brotli compression: `Content-Encoding: br`\n* Gzip compression: `Content-Encoding: gzip`\n* Deflate compression: `Content-Encoding: deflate`\n",
"operationId": "keyValueStore_record_put",
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record",
"https://docs.apify.com/api/v2#/reference/key-value-stores/put-record",
"https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_put"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "setRecord",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#setRecord",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "set_record",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#set_record"
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRecordRequest"
}
},
"*/*": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"summary": "Store record (POST)",
"description": "Stores a value under a specific key to the key-value store.\n\nThis endpoint is an alias for the [`PUT` record](#tag/Key-value-storesRecord/operation/keyValueStore_record_put) method and behaves identically.\n",
"operationId": "keyValueStore_record_post",
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/recordKey"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record",
"https://docs.apify.com/api/v2#/reference/key-value-stores/put-record",
"https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_post"
]
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Key-value stores"
],
"summary": "Delete record",
"description": "Removes a record specified by a key from the key-value store.",
"operationId": "keyValueStore_record_delete",
"parameters": [
{
"$ref": "#/components/parameters/storeId"
},
{
"$ref": "#/components/parameters/recordKey"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record",
"https://docs.apify.com/api/v2#/reference/key-value-stores/delete-record",
"https://docs.apify.com/api/v2#tag/Key-value-storesRecord/operation/keyValueStore_record_delete"
],
"x-js-parent": "KeyValueStoreClient",
"x-js-name": "deleteRecord",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#deleteRecord",
"x-py-parent": "KeyValueStoreClientAsync",
"x-py-name": "delete_record",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#delete_record"
}
},
"/v2/datasets": {
"get": {
"tags": [
"Storage/Datasets"
],
"summary": "Get list of datasets",
"description": "Lists all of a user's datasets.\n\nThe response is a JSON array of objects,\nwhere each object contains basic information about one dataset.\n\nBy default, the objects are sorted by the `createdAt` field in ascending\norder, therefore you can use pagination to incrementally fetch all datasets while new\nones are still being created. To sort them in descending order, use `desc=1`\nparameter. The endpoint supports pagination using `limit` and `offset`\nparameters and it will not return more than 1000 array elements.\n",
"operationId": "datasets_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
},
{
"$ref": "#/components/parameters/unnamed"
},
{
"name": "ownership",
"in": "query",
"description": "Filter by ownership. If this parameter is omitted, all accessible datasets are returned.\n\n- `ownedByMe`: Return only datasets owned by the user.\n- `sharedWithMe`: Return only datasets shared with the user by other users.\n",
"style": "form",
"explode": true,
"schema": {
"$ref": "#/components/schemas/StorageOwnership"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfDatasetsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets",
"https://docs.apify.com/api/v2#/reference/datasets/get-list-of-datasets",
"https://docs.apify.com/api/v2#tag/DatasetsDataset-collection/operation/datasets_get"
],
"x-js-parent": "DatasetCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetCollectionClient#list",
"x-py-parent": "DatasetCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClientAsync#list"
},
"post": {
"tags": [
"Storage/Datasets"
],
"summary": "Create dataset",
"description": "Creates a dataset and returns its object.\nKeep in mind that data stored under unnamed dataset follows [data retention period](https://docs.apify.com/platform/storage#data-retention).\nIt creates a dataset with the given name if the parameter name is used.\nIf a dataset with the given name already exists then returns its object.\n",
"operationId": "datasets_post",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Custom unique name to easily identify the dataset in the future.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "eshop-items"
}
}
],
"responses": {
"200": {
"description": "Returns the existing dataset object if a dataset with the given name already exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset",
"https://docs.apify.com/api/v2#/reference/datasets/create-dataset",
"https://docs.apify.com/api/v2#tag/DatasetsDataset-collection/operation/datasets_post"
],
"x-js-parent": "DatasetCollectionClient",
"x-js-name": "getOrCreate",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetCollectionClient#getOrCreate",
"x-py-parent": "DatasetCollectionClientAsync",
"x-py-name": "get_or_create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClientAsync#get_or_create"
}
},
"/v2/datasets/{datasetId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Datasets"
],
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
}
],
"summary": "Get dataset",
"description": "Returns dataset object for given dataset ID.\n\nThis does not return dataset items, only information about the storage itself.\nTo retrieve dataset items, use the [List dataset items](/api/v2/dataset-items-get) endpoint.\n\n:::note\n\nKeep in mind that attributes `itemCount` and `cleanItemCount` are not propagated right away after data are pushed into a dataset.\n\n:::\n\nThere is a short period (up to 5 seconds) during which these counters may not match with exact counts in dataset items.\n",
"operationId": "dataset_get",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset",
"https://docs.apify.com/api/v2#/reference/datasets/get-dataset",
"https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_get"
],
"x-js-parent": "DatasetClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#get",
"x-py-parent": "DatasetClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDatasetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Datasets"
],
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
}
],
"summary": "Update dataset",
"description": "Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload.\nThe response is the updated dataset object, as returned by the [Get dataset](/api/v2/dataset-get) API endpoint.\n",
"operationId": "dataset_put",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset",
"https://docs.apify.com/api/v2#/reference/datasets/update-dataset",
"https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_put"
],
"x-js-parent": "DatasetClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#update",
"x-py-parent": "DatasetClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#update"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Datasets"
],
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
}
],
"summary": "Delete dataset",
"description": "Deletes a specific dataset.",
"operationId": "dataset_delete",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset",
"https://docs.apify.com/api/v2#/reference/datasets/delete-dataset",
"https://docs.apify.com/api/v2#tag/DatasetsDataset/operation/dataset_delete"
],
"x-js-parent": "DatasetClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#delete"
}
},
"/v2/datasets/{datasetId}/items": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"foo": "bar"
},
{
"foo2": "bar2"
}
]
}
},
"application/jsonl": {
"schema": {
"type": "string"
},
"example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n"
},
"text/csv": {
"schema": {
"type": "string"
},
"example": "foo,bar\\nfoo2,bar2\\n"
},
"text/html": {
"schema": {
"type": "string"
},
"example": ""
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string"
}
},
"application/rss+xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
},
"application/xml": {
"schema": {
"type": "string"
},
"example": "- bar
- bar2
"
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Datasets"
],
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
},
{
"$ref": "#/components/parameters/signature"
}
],
"summary": "Get dataset items",
"description": "Returns data stored in the dataset in a desired format.\n\n### Response format\n\nThe format of the response depends on format query parameter.\n\nThe format parameter can have one of the following values:\njson, jsonl, xml, html,\ncsv, xlsx and rss.\n\nThe following table describes how each format is treated.\n\n\n \n | Format | \n Items | \n
\n \n json | \n The response is a JSON, JSONL or XML array of raw item objects. | \n
\n \n jsonl | \n
\n \n xml | \n
\n \n html | \n The response is a HTML, CSV or XLSX table, where columns correspond to the\n properties of the item and rows correspond to each dataset item. | \n
\n \n csv | \n
\n \n xlsx | \n
\n \n rss | \n The response is a RSS file. Each item is displayed as child elements of one\n <item>. | \n
\n
\n\nNote that CSV, XLSX and HTML tables are limited to 2000 columns and the column names cannot be longer than 200 characters.\nJSON, XML and RSS formats do not have such restrictions.\n\n### Hidden fields\n\nThe top-level fields starting with the `#` character are considered hidden.\nThese are useful to store debugging information and can be omitted from the output by providing the `skipHidden=1` or `clean=1` query parameters.\nFor example, if you store the following object to the dataset:\n\n```\n{\n productName: \"iPhone Xs\",\n description: \"Welcome to the big screens.\"\n #debug: {\n url: \"https://www.apple.com/lae/iphone-xs/\",\n crawledAt: \"2019-01-21T16:06:03.683Z\"\n }\n}\n```\n\nThe `#debug` field will be considered as hidden and can be omitted from the\nresults. This is useful to\nprovide nice cleaned data to end users, while keeping debugging info\navailable if needed. The Dataset object\nreturned by the API contains the number of such clean items in the`dataset.cleanItemCount` property.\n\n### XML format extension\n\nWhen exporting results to XML or RSS formats, the names of object properties become XML tags and the corresponding values become tag's children. For example, the following JavaScript object:\n\n```\n{\n name: \"Paul Newman\",\n address: [\n { type: \"home\", street: \"21st\", city: \"Chicago\" },\n { type: \"office\", street: null, city: null }\n ]\n}\n```\n\nwill be transformed to the following XML snippet:\n\n```\nPaul Newman\n\n home\n 21st\n Chicago\n\n\n office\n \n \n\n```\n\nIf the JavaScript object contains a property named `@` then its sub-properties are exported as attributes of the parent XML\nelement.\nIf the parent XML element does not have any child elements then its value is taken from a JavaScript object property named `#`.\n\nFor example, the following JavaScript object:\n\n```\n{\n \"address\": [{\n \"@\": {\n \"type\": \"home\"\n },\n \"street\": \"21st\",\n \"city\": \"Chicago\"\n },\n {\n \"@\": {\n \"type\": \"office\"\n },\n \"#\": 'unknown'\n }]\n}\n```\n\nwill be transformed to the following XML snippet:\n\n```\n\n 21st\n Chicago\n\nunknown\n```\n\nThis feature is also useful to customize your RSS feeds generated for various websites.\n\nBy default the whole result is wrapped in a `` element and each page object is wrapped in a `- ` element.\nYou can change this using
xmlRoot and xmlRow url parameters.\n\n### Pagination\n\nThe generated response supports [pagination](#/introduction/pagination).\nThe pagination is always performed with the granularity of a single item, regardless whether unwind parameter was provided.\nBy default, the **Items** in the response are sorted by the time they were stored to the database, therefore you can use pagination to incrementally fetch the items as they are being added.\nNo limit exists to how many items can be returned in one response.\n\nIf you specify `desc=1` query parameter, the results are returned in the reverse order than they were stored (i.e. from newest to oldest items).\nNote that only the order of **Items** is reversed, but not the order of the `unwind` array elements.\n",
"operationId": "dataset_items_get",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items",
"https://docs.apify.com/api/v2#/reference/datasets/get-items",
"https://docs.apify.com/api/v2#tag/DatasetsItem-collection/operation/dataset_items_get"
],
"x-js-parent": "DatasetClient",
"x-js-name": "listItems",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#listItems",
"x-py-parent": "DatasetClientAsync",
"x-py-name": "stream_items",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#stream_items"
},
"head": {
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
},
{
"$ref": "#/components/parameters/format"
},
{
"$ref": "#/components/parameters/clean"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit-2"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/outputFields"
},
{
"$ref": "#/components/parameters/omit"
},
{
"$ref": "#/components/parameters/unwind"
},
{
"$ref": "#/components/parameters/flatten"
},
{
"$ref": "#/components/parameters/descDataset"
},
{
"$ref": "#/components/parameters/attachment"
},
{
"$ref": "#/components/parameters/delimiter"
},
{
"$ref": "#/components/parameters/bom"
},
{
"$ref": "#/components/parameters/xmlRoot"
},
{
"$ref": "#/components/parameters/xmlRow"
},
{
"$ref": "#/components/parameters/skipHeaderRow"
},
{
"$ref": "#/components/parameters/skipHidden"
},
{
"$ref": "#/components/parameters/skipEmpty"
},
{
"$ref": "#/components/parameters/simplified"
},
{
"$ref": "#/components/parameters/view"
},
{
"$ref": "#/components/parameters/skipFailedPages"
},
{
"$ref": "#/components/parameters/feedTitle"
},
{
"$ref": "#/components/parameters/feedDescription"
},
{
"$ref": "#/components/parameters/signature"
}
],
"tags": [
"Storage/Datasets"
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"summary": "Get dataset items headers",
"description": "Returns only the HTTP headers for the dataset items endpoint, without the response body.\nThis is useful to check pagination metadata or verify access without downloading the full dataset.\n",
"operationId": "dataset_items_head"
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/PutItemsRequest"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PutItemsRequest"
}
}
],
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items"
}
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
}
}
}
},
"400": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/PutItemResponseError"
},
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Datasets"
],
"summary": "Store items",
"description": "Appends an item or an array of items to the end of the dataset.\nThe POST payload is a JSON object or a JSON array of objects to save into the dataset.\n\nIf the data you attempt to store in the dataset is invalid (meaning any of the items received by the API fails the validation), the whole request is discarded and the API will return a response with status code 400.\nFor more information about dataset schema validation, see [Dataset schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation).\n\n**IMPORTANT:** The limit of request payload size for the dataset is 5 MB. If the array exceeds the size, you'll need to split it into a number of smaller arrays.\n\nTo save bandwidth and speed up your upload, you can send the request payload compressed and set the `Content-Encoding` header accordingly.\n\nBelow is a list of supported `Content-Encoding` types.\n\n* Brotli: `Content-Encoding: br`\n* Gzip: `Content-Encoding: gzip`\n* Deflate: `Content-Encoding: deflate`\n",
"operationId": "dataset_items_post",
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items",
"https://docs.apify.com/api/v2#/reference/datasets/put-items",
"https://docs.apify.com/api/v2#tag/DatasetsItem-collection/operation/dataset_items_post"
],
"x-js-parent": "DatasetClient",
"x-js-name": "pushItems",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#pushItems",
"x-py-parent": "DatasetClientAsync",
"x-py-name": "push_items",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#push_items"
}
},
"/v2/datasets/{datasetId}/statistics": {
"get": {
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetStatisticsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"tags": [
"Storage/Datasets"
],
"summary": "Get dataset statistics",
"description": "Returns statistics for given dataset.\n\nProvides only [field statistics](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics).\n",
"operationId": "dataset_statistics_get",
"parameters": [
{
"$ref": "#/components/parameters/datasetId"
}
]
}
},
"/v2/request-queues": {
"get": {
"tags": [
"Storage/Request queues"
],
"summary": "Get list of request queues",
"description": "Lists all of a user's request queues. The response is a JSON array of\nobjects, where each object\ncontains basic information about one queue.\n\nBy default, the objects are sorted by the `createdAt` field in ascending order,\ntherefore you can use pagination to incrementally fetch all queues while new\nones are still being created. To sort them in descending order, use `desc=1`\nparameter. The endpoint supports pagination using `limit` and `offset`\nparameters and it will not return more than 1000\narray elements.\n",
"operationId": "requestQueues_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
},
{
"$ref": "#/components/parameters/unnamed"
},
{
"name": "ownership",
"in": "query",
"description": "Filter by ownership. If this parameter is omitted, all accessible request queues are returned.\n\n- `ownedByMe`: Return only request queues owned by the user.\n- `sharedWithMe`: Return only request queues shared with the user by other users.\n",
"style": "form",
"explode": true,
"schema": {
"$ref": "#/components/schemas/StorageOwnership"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfRequestQueuesResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues",
"https://docs.apify.com/api/v2#/reference/request-queues/get-list-of-request-queues",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue-collection/operation/requestQueues_get"
],
"x-js-parent": "RequestQueueCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueCollectionClient#list",
"x-py-parent": "RequestQueueCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClientAsync#list"
},
"post": {
"tags": [
"Storage/Request queues"
],
"summary": "Create request queue",
"description": "Creates a request queue and returns its object.\nKeep in mind that requests stored under unnamed queue follows [data\nretention period](https://docs.apify.com/platform/storage#data-retention).\n\nIt creates a queue of given name if the parameter name is used. If a queue\nwith the given name already exists then the endpoint returns\nits object.\n",
"operationId": "requestQueues_post",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Custom unique name to easily identify the queue in the future.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "example-com"
}
}
],
"responses": {
"200": {
"description": "Returns the existing request queue object if a queue with the given name already exists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/request-queues/WkzbQMuFYuamGv3YF"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue",
"https://docs.apify.com/api/v2#/reference/request-queues/create-request-queue",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue-collection/operation/requestQueues_post"
],
"x-js-parent": "RequestQueueCollectionClient",
"x-js-name": "getOrCreate",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueCollectionClient#getOrCreate",
"x-py-parent": "RequestQueueCollectionClientAsync",
"x-py-name": "get_or_create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClientAsync#get_or_create"
}
},
"/v2/request-queues/{queueId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues"
],
"parameters": [
{
"$ref": "#/components/parameters/queueId"
}
],
"summary": "Get request queue",
"description": "Returns queue object for given queue ID.",
"operationId": "requestQueue_get",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue",
"https://docs.apify.com/api/v2#/reference/request-queues/get-request-queue",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_get"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#get",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateRequestQueueRequest"
},
{
"example": {
"name": "new-request-queue-name"
}
}
]
},
"example": {
"name": "new-request-queue-name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestQueueResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues"
],
"parameters": [
{
"$ref": "#/components/parameters/queueId"
}
],
"summary": "Update request queue",
"description": "Updates a request queue's name and general resource access level using a value specified by a JSON object\npassed in the PUT payload.\n\nThe response is the updated request queue object, as returned by the\n[Get request queue](#/reference/request-queues/queue-collection/get-request-queue) API endpoint.\n",
"operationId": "requestQueue_put",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue",
"https://docs.apify.com/api/v2#/reference/request-queues/update-request-queue",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_put"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#update",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues"
],
"parameters": [
{
"$ref": "#/components/parameters/queueId"
}
],
"summary": "Delete request queue",
"description": "Deletes given queue.",
"operationId": "requestQueue_delete",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue",
"https://docs.apify.com/api/v2#/reference/request-queues/delete-request-queue",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_delete"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#delete"
}
},
"/v2/request-queues/{queueId}/requests/batch": {
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestWithoutId"
},
"description": ""
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchAddResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues"
],
"summary": "Add requests",
"description": "Adds requests to the queue in batch. The maximum requests in batch is limited\nto 25. The response contains an array of unprocessed and processed requests.\nIf any add operation fails because the request queue rate limit is exceeded\nor an internal failure occurs,\nthe failed request is returned in the unprocessedRequests response\nparameter.\nYou can resend these requests to add. It is recommended to use an\nexponential backoff algorithm for these retries.\nIf a request with the same `uniqueKey` was already present in the queue,\nthen it returns an ID of the existing request.\n",
"operationId": "requestQueue_requests_batch_post",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests",
"https://docs.apify.com/api/v2#/reference/request-queues/add-requests",
"https://docs.apify.com/api/v2#tag/Request-queuesBatch-request-operations/operation/requestQueue_requests_batch_post"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "batchAddRequests",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchAddRequests",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "batch_add_requests",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_add_requests"
},
"delete": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestDraftDelete"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDeleteResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues"
],
"summary": "Delete requests",
"description": "Batch-deletes given requests from the queue. The number of requests in a\nbatch is limited to 25. The response contains an array of unprocessed and\nprocessed requests.\nIf any delete operation fails because the request queue rate limit is\nexceeded or an internal failure occurs,\nthe failed request is returned in the `unprocessedRequests` response\nparameter.\nYou can re-send these delete requests. It is recommended to use an\nexponential backoff algorithm for these retries.\nEach request is identified by its ID or uniqueKey parameter. You can use\neither of them to identify the request.\n",
"operationId": "requestQueue_requests_batch_delete",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/contentTypeJson"
},
{
"$ref": "#/components/parameters/clientKey"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests",
"https://docs.apify.com/api/v2#/reference/request-queues/delete-requests",
"https://docs.apify.com/api/v2#tag/Request-queuesBatch-request-operations/operation/requestQueue_requests_batch_delete"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "batchDeleteRequests",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchDeleteRequests",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "batch_delete_requests",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_delete_requests"
}
},
"/v2/request-queues/{queueId}/requests/unlock": {
"post": {
"responses": {
"200": {
"description": "Number of requests that were unlocked",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests locks"
],
"summary": "Unlock requests",
"description": "Unlocks requests in the queue that are currently locked by the client.\n\n* If the client is within an Actor run, it unlocks all requests locked by that specific run plus all requests locked by the same clientKey.\n* If the client is outside of an Actor run, it unlocks all requests locked using the same clientKey.\n",
"operationId": "requestQueue_requests_unlock_post",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/clientKey"
}
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "unlockRequests",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#unlockRequests",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "unlock_requests",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#unlock_requests"
}
},
"/v2/request-queues/{queueId}/requests": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfRequestsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests"
],
"summary": "List requests",
"description": "Returns a list of requests. This endpoint is paginated using\ncursor (pagination by `exclusiveStartId` is deprecated) and limit parameters.\n",
"operationId": "requestQueue_requests_get",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/exclusiveStartId"
},
{
"$ref": "#/components/parameters/listLimit"
},
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/filter"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests",
"https://docs.apify.com/api/v2#/reference/request-queues/list-requests",
"https://docs.apify.com/api/v2#tag/Request-queuesRequest-collection/operation/requestQueue_requests_get"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "paginateRequests",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#paginateRequests",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "list_requests",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_requests"
},
"post": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests"
],
"summary": "Add request",
"description": "Adds request to the queue. Response contains ID of the request and info if\nrequest was already present in the queue or handled.\n\nIf request with same `uniqueKey` was already present in the queue then\nreturns an ID of existing request.\n",
"operationId": "requestQueue_requests_post",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/forefront"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request",
"https://docs.apify.com/api/v2#/reference/request-queues/add-request",
"https://docs.apify.com/api/v2#tag/Request-queuesRequest-collection/operation/requestQueue_requests_post"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "addRequest",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#addRequest",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "add_request",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#add_request"
}
},
"/v2/request-queues/{queueId}/requests/{requestId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests"
],
"summary": "Get request",
"description": "Returns request from queue.",
"operationId": "requestQueue_request_get",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/requestId"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue/get-request",
"https://docs.apify.com/api/v2#/reference/request-queues/get-request",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_get"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#get",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get"
},
"put": {
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestWithoutId"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRequestResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests"
],
"summary": "Update request",
"description": "Updates a request in a queue. Mark request as handled by setting\n`request.handledAt = new Date()`.\nIf `handledAt` is set, the request will be removed from head of the queue (and unlocked, if applicable).\n",
"operationId": "requestQueue_request_put",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/forefront"
},
{
"$ref": "#/components/parameters/clientKey"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request",
"https://docs.apify.com/api/v2#/reference/request-queues/update-request",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_put"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#update",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests"
],
"summary": "Delete request",
"description": "Deletes given request from queue.",
"operationId": "requestQueue_request_delete",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request",
"https://docs.apify.com/api/v2#/reference/request-queues/delete-request",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_delete"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#delete"
}
},
"/v2/request-queues/{queueId}/head": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests locks"
],
"summary": "Get head",
"description": "Returns given number of first requests from the queue.\n\nThe response contains the `hadMultipleClients` boolean field which indicates\nthat the queue was accessed by more than one client (with unique or empty\n`clientKey`).\nThis field is used by [Apify SDK](https://sdk.apify.com) to determine\nwhether the local cache is consistent with the request queue, and thus\noptimize performance of certain operations.\n",
"operationId": "requestQueue_head_get",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/headLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head",
"https://docs.apify.com/api/v2#/reference/request-queues/get-head",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue-head/operation/requestQueue_head_get"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "listHead",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#listHead",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "list_head",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_head"
}
},
"/v2/request-queues/{queueId}/head/lock": {
"post": {
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeadAndLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests locks"
],
"summary": "Get head and lock",
"description": "Returns the given number of first requests from the queue and locks them for\nthe given time.\n\nIf this endpoint locks the request, no other client or run will be able to get and\nlock these requests.\n\nThe response contains the `hadMultipleClients` boolean field which indicates\nthat the queue was accessed by more than one client (with unique or empty\n`clientKey`).\n",
"operationId": "requestQueue_head_lock_post",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/headLockLimit"
},
{
"$ref": "#/components/parameters/clientKey"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock",
"https://docs.apify.com/api/v2#/reference/request-queues/get-head-and-lock",
"https://docs.apify.com/api/v2#tag/Request-queuesQueue-head-with-locks/operation/requestQueue_head_lock_post"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "listAndLockHead",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#listAndLockHead",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "list_and_lock_head",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_and_lock_head"
}
},
"/v2/request-queues/{queueId}/requests/{requestId}/lock": {
"put": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProlongRequestLockResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests locks"
],
"summary": "Prolong request lock",
"description": "Prolongs request lock. The request lock can be prolonged only by the client\nthat has locked it using [Get and lock head\noperation](#/request-queue-head-lock-post).\n\nThe clientKey identifier is used for locking and unlocking requests.\nYou can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.\n",
"operationId": "requestQueue_request_lock_put",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/lockSecs"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/lockForefront"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock",
"https://docs.apify.com/api/v2#/reference/request-queues/prolong-request-lock",
"https://docs.apify.com/api/v2#tag/Request-queuesRequest-lock/operation/requestQueue_request_lock_put"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "prolongRequestLock",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#prolongRequestLock",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "prolong_request_lock",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#prolong_request_lock"
},
"delete": {
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Storage/Request queues/Requests locks"
],
"summary": "Delete request lock",
"description": "Deletes a request lock. The request lock can be deleted only by the client\nthat has locked it using [Get and lock head\noperation](#/request-queue-head-lock-post).\n\nThe clientKey identifier is used for locking and unlocking requests.\nYou can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.\n",
"operationId": "requestQueue_request_lock_delete",
"parameters": [
{
"$ref": "#/components/parameters/queueId"
},
{
"$ref": "#/components/parameters/requestId"
},
{
"$ref": "#/components/parameters/clientKey"
},
{
"$ref": "#/components/parameters/deleteForefront"
}
],
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock",
"https://docs.apify.com/api/v2#/reference/request-queues/delete-request-lock",
"https://docs.apify.com/api/v2#tag/Request-queuesRequest-lock/operation/requestQueue_request_lock_delete"
],
"x-js-parent": "RequestQueueClient",
"x-js-name": "deleteRequestLock",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#deleteRequestLock",
"x-py-parent": "RequestQueueClientAsync",
"x-py-name": "delete_request_lock",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#delete_request_lock"
}
},
"/v2/webhooks": {
"get": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Get list of webhooks",
"description": "Gets the list of webhooks that the user created.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\nBy default, the records are sorted by the `createdAt` field in ascending\norder. To sort the records in descending order, use the `desc=1`\nparameter.\n",
"operationId": "webhooks_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfWebhooksResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks",
"https://docs.apify.com/api/v2#/reference/webhooks/get-list-of-webhooks",
"https://docs.apify.com/api/v2#tag/WebhooksWebhook-collection/operation/webhooks_get"
],
"x-js-parent": "WebhookCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookCollectionClient#list",
"x-py-parent": "WebhookCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClientAsync#list"
},
"post": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Create webhook",
"description": "Creates a new webhook with settings provided by the webhook object passed as\nJSON in the payload.\nThe response is the created webhook object.\n\nTo avoid duplicating a webhook, use the `idempotencyKey` parameter in the\nrequest body.\nMultiple calls to create a webhook with the same `idempotencyKey` will only\ncreate the webhook with the first call and return the existing webhook on\nsubsequent calls.\nIdempotency keys must be unique, so use a UUID or another random string with\nenough entropy.\n\nTo assign the new webhook to an Actor or task, the request body must contain\n`requestUrl`, `eventTypes`, and `condition` properties.\n\n* `requestUrl` is the webhook's target URL, to which data is sent as a POST\nrequest with a JSON payload.\n* `eventTypes` is a list of events that will trigger the webhook, e.g. when\nthe Actor run succeeds.\n* `condition` should be an object containing the ID of the Actor or task to\nwhich the webhook will be assigned.\n* `payloadTemplate` is a JSON-like string, whose syntax is extended with the\nuse of variables.\n* `headersTemplate` is a JSON-like string, whose syntax is extended with the\nuse of variables. Following values will be re-written to defaults: \"host\",\n\"Content-Type\", \"X-Apify-Webhook\", \"X-Apify-Webhook-Dispatch-Id\",\n\"X-Apify-Request-Origin\"\n* `description` is an optional string.\n* `shouldInterpolateStrings` is a boolean indicating whether to interpolate\nvariables contained inside strings in the `payloadTemplate`\n\n```\n \"isAdHoc\" : false,\n \"requestUrl\" : \"https://example.com\",\n \"eventTypes\" : [\n \"ACTOR.RUN.SUCCEEDED\",\n \"ACTOR.RUN.ABORTED\"\n ],\n \"condition\" : {\n \"actorId\": \"5sTMwDQywwsLzKRRh\",\n \"actorTaskId\" : \"W9bs9JE9v7wprjAnJ\"\n },\n \"payloadTemplate\": \"\",\n \"headersTemplate\": \"\",\n \"description\": \"my awesome webhook\",\n \"shouldInterpolateStrings\": false,\n```\n\n**Important**: The request must specify the `Content-Type: application/json`\nHTTP header.\n",
"operationId": "webhooks_post",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/webhook/zdc3Pyhyz3m8vjDeM"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook",
"https://docs.apify.com/api/v2#/reference/webhooks/create-webhook",
"https://docs.apify.com/api/v2#tag/WebhooksWebhook-collection/operation/webhooks_post"
],
"x-js-parent": "WebhookCollectionClient",
"x-js-name": "create",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookCollectionClient#create",
"x-py-parent": "WebhookCollectionClientAsync",
"x-py-name": "create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClientAsync#create"
}
},
"/v2/webhooks/{webhookId}": {
"get": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Get webhook",
"description": "Gets webhook object with all details.",
"operationId": "webhook_get",
"parameters": [
{
"$ref": "#/components/parameters/webhookId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook",
"https://docs.apify.com/api/v2#/reference/webhooks/get-webhook",
"https://docs.apify.com/api/v2#tag/WebhooksWebhook-object/operation/webhook_get"
],
"x-js-parent": "WebhookClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#get",
"x-py-parent": "WebhookClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#get"
},
"put": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Update webhook",
"description": "Updates a webhook using values specified by a webhook object passed as JSON\nin the POST payload.\nIf the object does not define a specific property, its value will not be\nupdated.\n\nThe response is the full webhook object as returned by the\n[Get webhook](#/reference/webhooks/webhook-object/get-webhook) endpoint.\n\nThe request needs to specify the `Content-Type: application/json` HTTP\nheader!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL. ([More\ninfo](#/introduction/authentication)).\n",
"operationId": "webhook_put",
"parameters": [
{
"$ref": "#/components/parameters/webhookId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook",
"https://docs.apify.com/api/v2#/reference/webhooks/update-webhook",
"https://docs.apify.com/api/v2#tag/WebhooksWebhook-object/operation/webhook_put"
],
"x-js-parent": "WebhookClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#update",
"x-py-parent": "WebhookClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#update"
},
"delete": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Delete webhook",
"description": "Deletes a webhook.",
"operationId": "webhook_delete",
"parameters": [
{
"$ref": "#/components/parameters/webhookId"
}
],
"responses": {
"204": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook",
"https://docs.apify.com/api/v2#/reference/webhooks/delete-webhook",
"https://docs.apify.com/api/v2#tag/WebhooksWebhook-object/operation/webhook_delete"
],
"x-js-parent": "WebhookClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#delete"
}
},
"/v2/webhooks/{webhookId}/test": {
"post": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Test webhook",
"description": "Tests a webhook. Creates a webhook dispatch with a dummy payload.",
"operationId": "webhook_test_post",
"parameters": [
{
"$ref": "#/components/parameters/webhookId"
}
],
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestWebhookResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook",
"https://docs.apify.com/api/v2#/reference/webhooks/test-webhook",
"https://docs.apify.com/api/v2#tag/WebhooksWebhook-test/operation/webhook_test_post"
],
"x-js-parent": "WebhookClient",
"x-js-name": "test",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#test",
"x-py-parent": "WebhookClientAsync",
"x-py-name": "test",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#test"
}
},
"/v2/webhooks/{webhookId}/dispatches": {
"get": {
"tags": [
"Webhooks/Webhooks"
],
"summary": "Get collection",
"description": "Gets a given webhook's list of dispatches.",
"operationId": "webhook_webhookDispatches_get",
"parameters": [
{
"$ref": "#/components/parameters/webhookId"
},
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfWebhookDispatchesResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection",
"https://docs.apify.com/api/v2#/reference/webhooks/get-collection",
"https://docs.apify.com/api/v2#tag/WebhooksDispatches-collection/operation/webhook_dispatches_get"
],
"x-py-parent": "WebhookClientAsync",
"x-py-name": "dispatches",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#dispatches"
}
},
"/v2/webhook-dispatches": {
"get": {
"tags": [
"Webhooks/Webhook dispatches"
],
"summary": "Get list of webhook dispatches",
"description": "Gets the list of webhook dispatches that the user have.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters\nand it will not return more than 1000 records.\nBy default, the records are sorted by the `createdAt` field in ascending\norder. To sort the records in descending order, use the `desc=1`\nparameter.\n",
"operationId": "webhookDispatches_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfWebhookDispatchesResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches",
"https://docs.apify.com/api/v2#/reference/webhook-dispatches/get-list-of-webhook-dispatches",
"https://docs.apify.com/api/v2#tag/Webhook-dispatchesWebhook-dispatches-collection/operation/webhookDispatches_get"
],
"x-js-parent": "WebhookDispatchCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookDispatchCollectionClient#list",
"x-py-parent": "WebhookDispatchCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookDispatchCollectionClientAsync#list"
}
},
"/v2/webhook-dispatches/{dispatchId}": {
"get": {
"tags": [
"Webhooks/Webhook dispatches"
],
"summary": "Get webhook dispatch",
"description": "Gets webhook dispatch object with all details.",
"operationId": "webhookDispatch_get",
"parameters": [
{
"name": "dispatchId",
"in": "path",
"description": "Webhook dispatch ID.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "Zib4xbZsmvZeK55ua"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookDispatchResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch",
"https://docs.apify.com/api/v2#/reference/webhook-dispatches/get-webhook-dispatch",
"https://docs.apify.com/api/v2#tag/Webhook-dispatchesWebhook-dispatch-object/operation/webhookDispatch_get"
],
"x-js-parent": "WebhookDispatchClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookDispatchClient#get",
"x-py-parent": "WebhookDispatchClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookDispatchClientAsync#get"
}
},
"/v2/schedules": {
"get": {
"tags": [
"Schedules"
],
"summary": "Get list of schedules",
"description": "Gets the list of schedules that the user created.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters.\nIt will not return more than 1000 records.\n\nBy default, the records are sorted by the `createdAt` field in ascending\norder. To sort the records in descending order, use the `desc=1` parameter.\n",
"operationId": "schedules_get",
"parameters": [
{
"$ref": "#/components/parameters/offset"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/descCreatedAt"
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfSchedulesResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules",
"https://docs.apify.com/api/v2#/reference/schedules/get-list-of-schedules",
"https://docs.apify.com/api/v2#tag/SchedulesSchedules-collection/operation/schedules_get"
],
"x-js-parent": "ScheduleCollectionClient",
"x-js-name": "list",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleCollectionClient#list",
"x-py-parent": "ScheduleCollectionClientAsync",
"x-py-name": "list",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClientAsync#list"
},
"post": {
"tags": [
"Schedules"
],
"summary": "Create schedule",
"description": "Creates a new schedule with settings provided by the schedule object passed\nas JSON in the payload. The response is the created schedule object.\n\nThe request needs to specify the `Content-Type: application/json` HTTP header!\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL. ([More\ninfo](#/introduction/authentication)).\n",
"operationId": "schedules_post",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "",
"headers": {
"Location": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "https://api.apify.com/v2/schedules/asdLZtadYvn4mBZmm"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule",
"https://docs.apify.com/api/v2#/reference/schedules/create-schedule",
"https://docs.apify.com/api/v2#tag/SchedulesSchedules-collection/operation/schedules_post"
],
"x-js-parent": "ScheduleCollectionClient",
"x-js-name": "create",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleCollectionClient#create",
"x-py-parent": "ScheduleCollectionClientAsync",
"x-py-name": "create",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClientAsync#create"
}
},
"/v2/schedules/{scheduleId}": {
"get": {
"tags": [
"Schedules"
],
"summary": "Get schedule",
"description": "Gets the schedule object with all details.",
"operationId": "schedule_get",
"parameters": [
{
"$ref": "#/components/parameters/scheduleId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule",
"https://docs.apify.com/api/v2#/reference/schedules/get-schedule",
"https://docs.apify.com/api/v2#tag/SchedulesSchedule-object/operation/schedule_get"
],
"x-js-parent": "ScheduleClient",
"x-js-name": "get",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#get",
"x-py-parent": "ScheduleClientAsync",
"x-py-name": "get",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#get"
},
"put": {
"tags": [
"Schedules"
],
"summary": "Update schedule",
"description": "Updates a schedule using values specified by a schedule object passed as\nJSON in the POST payload. If the object does not define a specific property,\nits value will not be updated.\n\nThe response is the full schedule object as returned by the\n[Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint.\n\n**The request needs to specify the `Content-Type: application/json` HTTP\nheader!**\n\nWhen providing your API authentication token, we recommend using the\nrequest's `Authorization` header, rather than the URL. ([More\ninfo](#/introduction/authentication)).\n",
"operationId": "schedule_put",
"parameters": [
{
"$ref": "#/components/parameters/scheduleId"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCreate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule",
"https://docs.apify.com/api/v2#/reference/schedules/update-schedule",
"https://docs.apify.com/api/v2#tag/SchedulesSchedule-object/operation/schedule_put"
],
"x-js-parent": "ScheduleClient",
"x-js-name": "update",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#update",
"x-py-parent": "ScheduleClientAsync",
"x-py-name": "update",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#update"
},
"delete": {
"tags": [
"Schedules"
],
"summary": "Delete schedule",
"description": "Deletes a schedule.",
"operationId": "schedule_delete",
"parameters": [
{
"$ref": "#/components/parameters/scheduleId"
}
],
"responses": {
"204": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object",
"example": {}
},
"example": {}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule",
"https://docs.apify.com/api/v2#/reference/schedules/delete-schedule",
"https://docs.apify.com/api/v2#tag/SchedulesSchedule-object/operation/schedule_delete"
],
"x-js-parent": "ScheduleClient",
"x-js-name": "delete",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#delete"
}
},
"/v2/schedules/{scheduleId}/log": {
"get": {
"tags": [
"Schedules"
],
"summary": "Get schedule log",
"description": "Gets the schedule log as a JSON array containing information about up to a\n1000 invocations of the schedule.\n",
"operationId": "schedule_log_get",
"parameters": [
{
"$ref": "#/components/parameters/scheduleId"
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleLogResponse"
},
"example": {
"data": [
{
"message": "Schedule invoked",
"level": "INFO",
"createdAt": "2019-03-26T12:28:00.370Z"
},
{
"message": "Cannot start Actor task \\\"iEvfA6pm6DWjRTGxS\\\": Provided input must be object, got \\\"string\\\" instead.",
"level": "ERROR",
"createdAt": "2019-03-26T12:30:00.325Z"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log",
"https://docs.apify.com/api/v2#/reference/schedules/get-schedule-log",
"https://docs.apify.com/api/v2#tag/SchedulesSchedule-log/operation/schedule_log_get"
],
"x-js-parent": "ScheduleClient",
"x-js-name": "getLog",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#getLog",
"x-py-parent": "ScheduleClientAsync",
"x-py-name": "get_log",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#get_log"
}
},
"/v2/store": {
"get": {
"tags": [
"Store"
],
"summary": "Get list of Actors in Store",
"description": "Gets the list of public Actors in Apify Store. You can use `search`\nparameter to search Actors by string in title, name, description, username\nand readme.\nIf you need detailed info about a specific Actor, use the [Get\nActor](#/reference/actors/actor-object/get-actor) endpoint.\n\nThe endpoint supports pagination using the `limit` and `offset` parameters.\nIt will not return more than 1,000 records.\n",
"operationId": "store_get",
"parameters": [
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/offset"
},
{
"name": "search",
"in": "query",
"description": "String to search by. The search runs on the following fields: `title`,\n`name`, `description`, `username`, `readme`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "web scraper"
}
},
{
"name": "sortBy",
"in": "query",
"description": "Specifies the field by which to sort the results. The supported values\nare `relevance` (default), `popularity`, `newest` and `lastUpdate`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "'popularity'"
}
},
{
"name": "category",
"in": "query",
"description": "Filters the results by the specified category.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "'AI'"
}
},
{
"name": "username",
"in": "query",
"description": "Filters the results by the specified username.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "'apify'"
}
},
{
"name": "pricingModel",
"in": "query",
"description": "Only return Actors with the specified pricing model.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"FREE",
"FLAT_PRICE_PER_MONTH",
"PRICE_PER_DATASET_ITEM",
"PAY_PER_EVENT"
],
"example": "FREE"
}
},
{
"name": "allowsAgenticUsers",
"in": "query",
"description": "If true, only return Actors that allow agentic users. If false, only\nreturn Actors that do not allow agentic users.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
{
"name": "responseFormat",
"in": "query",
"description": "Controls the shape of the response. Use `full` (default) for the\ncomplete response including image URLs and all fields. Use `agent`\nfor a reduced field set optimized for LLM consumers, which only\nincludes `id`, `title`, `name`, `username`, `description`, `notice`,\n`badge`, `categories`, and minimal `stats`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"enum": [
"full",
"agent"
],
"default": "full",
"example": "agent"
}
},
{
"name": "includeUnrunnableActors",
"in": "query",
"description": "By default, search results exclude Actors that are not safe to run\nautomatically (e.g. Actors from developers who haven't passed KYC, or\nfull-permission Actors without a large user base). Set to `true` to\nbypass this safety filtering and include all Actors in the results.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"default": false,
"example": true
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
"X-Apify-Pagination-Offset": {
"description": "The offset of the first item in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "0"
}
}
},
"X-Apify-Pagination-Limit": {
"description": "The maximum number of items returned per page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Count": {
"description": "The number of items returned in the current page.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "100"
}
}
},
"X-Apify-Pagination-Total": {
"description": "The total number of items available.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "10204"
}
}
},
"X-Apify-Pagination-Desc": {
"description": "Whether the items are sorted in descending order.",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": "false"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListOfActorsInStoreResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/store/store-actors-collection/get-list-of-actors-in-store",
"https://docs.apify.com/api/v2#/reference/store/get-list-of-actors-in-store",
"https://docs.apify.com/api/v2#tag/StoreStore-Actors-collection/operation/store_get"
]
}
},
"/v2/logs/{buildOrRunId}": {
"get": {
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "2017-07-14T06:00:49.733Z Application started.\n2017-07-14T06:00:49.741Z Input: { test: 123 }\n2017-07-14T06:00:49.752Z Some useful debug information follows.\n"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"tags": [
"Logs"
],
"summary": "Get log",
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/logs/log/get-log",
"https://docs.apify.com/api/v2#/reference/logs/get-log",
"https://docs.apify.com/api/v2#tag/LogsLog/operation/log_get"
],
"description": "Retrieves logs for a specific Actor build or run.\n",
"operationId": "log_get",
"parameters": [
{
"$ref": "#/components/parameters/buildOrRunId"
},
{
"$ref": "#/components/parameters/stream"
},
{
"$ref": "#/components/parameters/download"
},
{
"$ref": "#/components/parameters/raw"
}
],
"security": [
{
"httpBearer": []
},
{
"apiKey": []
},
{}
],
"x-js-parent": "LogClient",
"x-js-name": "stream",
"x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/LogClient#stream",
"x-py-parent": "LogClientAsync",
"x-py-name": "stream",
"x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/LogClientAsync#stream"
}
},
"/v2/users/{userId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get public user data",
"description": "Returns public information about a specific user account, similar to what\ncan be seen on public profile pages (e.g. https://apify.com/apify).\n\nThis operation requires no authentication token.\n",
"operationId": "user_get",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "User ID or username.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "HGzIk8z78YcAPEB"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicUserDataResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/users/public-data/get-public-user-data",
"https://docs.apify.com/api/v2#/reference/users/get-public-user-data",
"https://docs.apify.com/api/v2#tag/UsersPublic-data/operation/user_get"
]
}
},
"/v2/users/me": {
"get": {
"tags": [
"Users"
],
"summary": "Get private user data",
"description": "Returns information about the current user account, including both public\nand private information.\n\nThe user account is identified by the provided authentication token.\n\nThe fields `plan`, `email` and `profile` are omitted when this endpoint is accessed from Actor run.\n",
"operationId": "users_me_get",
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateUserDataResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/users/private-data/get-private-user-data",
"https://docs.apify.com/api/v2#/reference/users/get-private-user-data",
"https://docs.apify.com/api/v2#tag/UsersPrivate-data/operation/users_me_get"
]
}
},
"/v2/users/me/usage/monthly": {
"get": {
"tags": [
"Users/Usage"
],
"summary": "Get monthly usage",
"description": "Returns a complete summary of your usage for the current monthly usage cycle,\nan overall sum, as well as a daily breakdown of usage. It is the same\ninformation you will see on your account's [Billing > Historical usage page](https://console.apify.com/billing/historical-usage). The information\nincludes your use of Actors, compute, data transfer, and storage.\n\nUsing the `date` parameter will show your usage in the monthly usage cycle that\nincludes that date.\n",
"operationId": "users_me_usage_monthly_get",
"parameters": [
{
"name": "date",
"in": "query",
"description": "Date in the YYYY-MM-DD format.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "2020-06-14"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MonthlyUsageResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/users/monthly-usage/get-monthly-usage",
"https://docs.apify.com/api/v2#/reference/users/get-monthly-usage",
"https://docs.apify.com/api/v2#tag/UsersMonthly-usage/operation/users_me_usage_monthly_get"
]
}
},
"/v2/users/me/limits": {
"get": {
"tags": [
"Users/Usage"
],
"summary": "Get limits",
"description": "Returns a complete summary of your account's limits. It is the same\ninformation you will see on your account's [Limits page](https://console.apify.com/billing#/limits). The returned data\nincludes the current usage cycle, a summary of your limits, and your current usage.\n",
"operationId": "users_me_limits_get",
"responses": {
"200": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitsResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/users/account-and-usage-limits/get-limits",
"https://docs.apify.com/api/v2#/reference/users/get-limits",
"https://docs.apify.com/api/v2#tag/UsersAccount-and-usage-limits/operation/users_me_limits_get"
]
},
"put": {
"tags": [
"Users/Usage"
],
"summary": "Update limits",
"description": "Updates the account's limits manageable on your account's [Limits page](https://console.apify.com/billing#/limits).\nSpecifically the: `maxMonthlyUsageUsd` and `dataRetentionDays` limits (see request body schema for more details).\n",
"operationId": "users_me_limits_put",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLimitsRequest"
}
}
}
},
"responses": {
"201": {
"description": "",
"headers": {},
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"x-legacy-doc-urls": [
"https://docs.apify.com/api/v2#/reference/users/account-and-usage-limits/update-limits",
"https://docs.apify.com/api/v2#/reference/users/update-limits",
"https://docs.apify.com/api/v2#tag/UsersAccount-and-usage-limits/operation/users_me_limits_put"
]
}
},
"/v2/browser-info": {
"get": {
"tags": [
"Tools"
],
"summary": "Get browser info",
"description": "Returns information about the HTTP request, including the client IP address,\ncountry code, request headers, and body length.\n\nThis endpoint is designed for proxy testing. It accepts any HTTP method so you\ncan verify that your proxy correctly forwards requests of any type and that\nclient IP addresses are anonymized.\n",
"security": [],
"parameters": [
{
"name": "skipHeaders",
"in": "query",
"description": "If `true` or `1`, the response omits the `headers` field.",
"schema": {
"type": "boolean"
}
},
{
"name": "rawHeaders",
"in": "query",
"description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserInfoResponse"
}
}
}
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"operationId": "tools_browser_info_get"
},
"post": {
"tags": [
"Tools"
],
"summary": "Get browser info",
"description": "Returns information about the HTTP request, including the client IP address,\ncountry code, request headers, and body length.\n\nThis endpoint is designed for proxy testing. It accepts any HTTP method so you\ncan verify that your proxy correctly forwards requests of any type and that\nclient IP addresses are anonymized.\n",
"security": [],
"parameters": [
{
"name": "skipHeaders",
"in": "query",
"description": "If `true` or `1`, the response omits the `headers` field.",
"schema": {
"type": "boolean"
}
},
{
"name": "rawHeaders",
"in": "query",
"description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserInfoResponse"
}
}
}
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"operationId": "tools_browser_info_post"
},
"put": {
"tags": [
"Tools"
],
"summary": "Get browser info",
"description": "Returns information about the HTTP request, including the client IP address,\ncountry code, request headers, and body length.\n\nThis endpoint is designed for proxy testing. It accepts any HTTP method so you\ncan verify that your proxy correctly forwards requests of any type and that\nclient IP addresses are anonymized.\n",
"security": [],
"parameters": [
{
"name": "skipHeaders",
"in": "query",
"description": "If `true` or `1`, the response omits the `headers` field.",
"schema": {
"type": "boolean"
}
},
{
"name": "rawHeaders",
"in": "query",
"description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserInfoResponse"
}
}
}
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"operationId": "tools_browser_info_put"
},
"delete": {
"tags": [
"Tools"
],
"summary": "Get browser info",
"description": "Returns information about the HTTP request, including the client IP address,\ncountry code, request headers, and body length.\n\nThis endpoint is designed for proxy testing. It accepts any HTTP method so you\ncan verify that your proxy correctly forwards requests of any type and that\nclient IP addresses are anonymized.\n",
"security": [],
"parameters": [
{
"name": "skipHeaders",
"in": "query",
"description": "If `true` or `1`, the response omits the `headers` field.",
"schema": {
"type": "boolean"
}
},
{
"name": "rawHeaders",
"in": "query",
"description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserInfoResponse"
}
}
}
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false,
"operationId": "tools_browser_info_delete"
}
},
"/v2/tools/encode-and-sign": {
"post": {
"tags": [
"Tools/Encoding"
],
"summary": "Encode and sign object",
"description": "Encodes and signs any JSON object. The encoded value includes a signature\ntied to the authenticated user's ID, which can later be verified using the\ndecode-and-verify endpoint.\n\n**Important**: The request must specify the `Content-Type: application/json`\nHTTP header.\n",
"operationId": "tools_encode_and_sign_post",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"key": "value"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EncodeAndSignResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false
}
},
"/v2/tools/decode-and-verify": {
"post": {
"tags": [
"Tools/Encoding"
],
"summary": "Decode and verify object",
"description": "Decodes and verifies an encoded value previously created by the\nencode-and-sign endpoint. Returns the original decoded object along with\ninformation about the user who encoded it and whether that user is verified.\n\n**Important**: The request must specify the `Content-Type: application/json`\nHTTP header.\n",
"operationId": "tools_decode_and_verify_post",
"security": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecodeAndVerifyRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecodeAndVerifyResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
},
"415": {
"$ref": "#/components/responses/UnsupportedMediaType"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"deprecated": false
}
}
},
"components": {
"securitySchemes": {
"httpBearer": {
"type": "http",
"scheme": "bearer",
"description": "Bearer token provided in the `Authorization` header (e.g., `Authorization: Bearer your_token`—recommended). [More info](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).\n\nUse your API token to authenticate requests. You can find it on the [Integrations page](https://console.apify.com/account#/integrations) in Apify Console. This method is more secure than query parameters, as headers are not logged in browser history or server logs.\n\n:::danger Security\n\nDo not share your API token (or account password) with untrusted parties.\n\n:::\n\n_When is authentication required?_\n- _Required_ for private Actors, tasks, or resources (e.g., builds of private Actors).\n- _Required_ when using named formats for IDs (e.g., `username~store-name` for stores or `username~queue-name` for queues).\n- _Optional_ for public Actors or resources (e.g., builds of public Actors can be queried without a token).\n\nFor more information, see our [integrations documentation](https://docs.apify.com/platform/integrations)."
},
"apiKey": {
"type": "apiKey",
"name": "token",
"in": "query",
"description": "API token provided as a query parameter (e.g., `?token=your_token`—less secure).\n\nUse your API token to authenticate requests. You can find it on the [Integrations page](https://console.apify.com/account#/integrations) in Apify Console.\n\n:::danger Security\n\nDo not share your API token (or account password) with untrusted parties.\n\n:::\n\n_When is authentication required?_\n- _Required_ for private Actors, tasks, or resources (e.g., builds of private Actors).\n- _Required_ when using named formats for IDs (e.g., `username~store-name` for stores or `username~queue-name` for queues).\n- _Optional_ for public Actors or resources (e.g., builds of public Actors can be queried without a token).\n\nFor more information, see our [integrations documentation](https://docs.apify.com/platform/integrations)."
}
},
"parameters": {
"offset": {
"name": "offset",
"in": "query",
"description": "Number of items that should be skipped at the start. The default value is `0`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 0
}
},
"limit": {
"name": "limit",
"in": "query",
"description": "Maximum number of items to return. The default value as well as the maximum is `1000`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 1000
}
},
"descCreatedAt": {
"name": "desc",
"in": "query",
"description": "If `true` or `1` then the objects are sorted by the `createdAt` field in\ndescending order. By default, they are sorted in ascending order.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"actorId": {
"name": "actorId",
"in": "path",
"description": "Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (`~`).",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "compass~google-maps-extractor"
}
},
"versionNumber": {
"name": "versionNumber",
"in": "path",
"description": "Actor version.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "0.1"
}
},
"descStartedAt": {
"name": "desc",
"in": "query",
"description": "If `true` or `1` then the objects are sorted by the `startedAt` field in\ndescending order. By default, they are sorted in ascending order.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"waitForFinishBuild": {
"name": "waitForFinish",
"in": "query",
"description": "The maximum number of seconds the server waits for the build to finish.\nBy default it is `0`, the maximum value is `60`. \nIf the build finishes in time then the returned build object will have a\nterminal status (e.g. `SUCCEEDED`), otherwise it will have a transitional status (e.g. `RUNNING`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 60
}
},
"buildIdWithDefault": {
"name": "buildId",
"in": "path",
"description": "ID of the build, found in the build's Info tab.\nUse the special value `default` to get the OpenAPI schema for the Actor's default build.\n",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "soSkq9ekdmfOslopH"
}
},
"buildId": {
"name": "buildId",
"in": "path",
"description": "ID of the build, found in the build's Info tab.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "soSkq9ekdmfOslopH"
}
},
"status": {
"name": "status",
"in": "query",
"description": "Single status or comma-separated list of statuses, see ([available\nstatuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)). Used to filter runs by the specified statuses only.\n",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SUCCEEDED"
]
}
},
"startedAfter": {
"name": "startedAfter",
"in": "query",
"description": "Filter runs that started after the specified date and time (inclusive).\nThe value must be a valid ISO 8601 datetime string (UTC).\n",
"style": "form",
"explode": true,
"allowReserved": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-09-01T00:00:00.000Z"
}
},
"startedBefore": {
"name": "startedBefore",
"in": "query",
"description": "Filter runs that started before the specified date and time (inclusive).\nThe value must be a valid ISO 8601 datetime string (UTC).\n",
"style": "form",
"explode": true,
"allowReserved": true,
"schema": {
"type": "string",
"format": "date-time",
"example": "2025-09-17T23:59:59.000Z"
}
},
"timeout": {
"name": "timeout",
"in": "query",
"description": "Optional timeout for the run, in seconds. By default, the run uses the timeout from its configuration.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 60
}
},
"memory": {
"name": "memory",
"in": "query",
"description": "Memory limit for the run, in megabytes. You can set the amount of memory to a power of 2 with a minimum of 128.\nBy default, the run uses the memory limit from its configuration. Don't change this value unless the Actor's\ndocumentation recommends it or you're aware of the consequences.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 256
}
},
"maxItems": {
"name": "maxItems",
"in": "query",
"required": false,
"description": "Specifies the maximum number of dataset items that will be charged for pay-per-result Actors.\nThis does NOT guarantee that the Actor will return only this many items.\nIt only ensures you won't be charged for more than this number of items.\nOnly works for pay-per-result Actors.\nValue can be accessed in the actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 1000
}
},
"maxTotalChargeUsd": {
"name": "maxTotalChargeUsd",
"in": "query",
"required": false,
"description": "Specifies the maximum total cost of the run.\nUse it to cap the total amount charged for all pricing models.\nYou can access the maximum cost in your Actor\nby using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 5
}
},
"restartOnError": {
"name": "restartOnError",
"in": "query",
"description": "Determines whether the run will be restarted if it fails.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"build": {
"name": "build",
"in": "query",
"description": "Specifies the Actor build to run. It can be either a build tag or build number.\nBy default, the run uses the build from its configuration (typically `latest`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "0.1.234"
}
},
"waitForFinishRun": {
"name": "waitForFinish",
"in": "query",
"description": "The maximum number of seconds the server waits for the run to finish. By\ndefault it is `0`, the maximum value is `60`. \nIf the run finishes in time then the returned run object will have a terminal status (e.g. `SUCCEEDED`),\notherwise it will have a transitional status (e.g. `RUNNING`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 60
}
},
"webhooks": {
"name": "webhooks",
"in": "query",
"description": "Specifies optional webhooks associated with the Actor run, which can be used to receive a notification\ne.g. when the Actor finished or failed. The value is a Base64-encoded JSON array whose items follow\nthe WebhookRepresentation schema. For more information, see\n[Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"contentEncoding": "base64",
"contentMediaType": "application/json",
"contentSchema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookRepresentation"
}
},
"example": "dGhpcyBpcyBqdXN0IGV4YW1wbGUK..."
}
},
"outputRecordKey": {
"name": "outputRecordKey",
"in": "query",
"description": "Key of the record from the run's default key-value store to return in the\nresponse. Defaults to `OUTPUT`. Actors aren't required to store a record\nunder this key, so if it doesn't exist the response contains no data.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "OUTPUT"
}
},
"format": {
"name": "format",
"in": "query",
"description": "Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "json"
}
},
"clean": {
"name": "clean",
"in": "query",
"description": "If `true` or `1` then the API endpoint returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe `clean` parameter is just a shortcut for `skipHidden=true` and `skipEmpty=true` parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the `limit` value.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"limit-2": {
"name": "limit",
"in": "query",
"description": "Maximum number of items to return. By default there is no limit.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double"
}
},
"fields": {
"name": "fields",
"in": "query",
"description": "A comma-separated list of fields which should be picked from the items, only these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the `fields` query parameter.\nYou can use this feature to effectively fix the output format.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "myValue,myOtherValue"
}
},
"outputFields": {
"name": "outputFields",
"in": "query",
"description": "A comma-separated list of output field names that positionally rename the fields specified in the `fields` parameter.\nFor example, `?fields=headline,url&outputFields=title,link` renames `headline` to `title` and `url` to `link` in the output.\nThe number of names in `outputFields` must match the number of names in `fields`.\nRequires the `fields` parameter to be specified as well.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "title,link"
}
},
"omit": {
"name": "omit",
"in": "query",
"description": "A comma-separated list of fields which should be omitted from the items.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "myValue,myOtherValue"
}
},
"unwind": {
"name": "unwind",
"in": "query",
"description": "A comma-separated list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object then the item gets preserved as it is.\nNote that the unwound items ignore the `desc` parameter.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "myValue,myOtherValue"
}
},
"flatten": {
"name": "flatten",
"in": "query",
"description": "A comma-separated list of fields which should transform nested objects into flat structures.\n\nFor example, with `flatten=\"foo\"` the object `{\"foo\":{\"bar\": \"hello\"}}` is turned into `{\"foo.bar\": \"hello\"}`.\n\nThe original object with properties is replaced with the flattened object.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "myValue"
}
},
"descDataset": {
"name": "desc",
"in": "query",
"description": "By default, results are returned in the same order as they were stored.\nTo reverse the order, set this parameter to `true` or `1`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"attachment": {
"name": "attachment",
"in": "query",
"description": "If `true` or `1` then the response will define the `Content-Disposition:\nattachment` header, forcing a web browser to download the file rather\nthan to display it. By default this header is not present.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"delimiter": {
"name": "delimiter",
"in": "query",
"description": "A delimiter character for CSV files, only used if `format=csv`. You\nmight need to URL-encode the character (e.g. use `%09` for tab or `%3B`\nfor semicolon). The default delimiter is a simple comma (`,`).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": ";"
}
},
"bom": {
"name": "bom",
"in": "query",
"description": "All text responses are encoded in UTF-8 encoding. By default, the\n`format=csv` files are prefixed with the UTF-8 Byte Order Mark (BOM), while `json`, `jsonl`, `xml`, `html` and `rss` files are not.\n\nIf you want to override this default behavior, specify `bom=1` query parameter to include the BOM or `bom=0` to skip it.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"xmlRoot": {
"name": "xmlRoot",
"in": "query",
"description": "Overrides default root element name of `xml` output. By default the root element is `items`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "items"
}
},
"xmlRow": {
"name": "xmlRow",
"in": "query",
"description": "Overrides default element name that wraps each page or page function result object in `xml` output. By default the element name is `item`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "item"
}
},
"skipHeaderRow": {
"name": "skipHeaderRow",
"in": "query",
"description": "If `true` or `1` then header row in the `csv` format is skipped.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"skipHidden": {
"name": "skipHidden",
"in": "query",
"description": "If `true` or `1` then hidden fields are skipped from the output, i.e. fields starting with the `#` character.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"skipEmpty": {
"name": "skipEmpty",
"in": "query",
"description": "If `true` or `1` then empty items are skipped from the output.\n\nNote that if used, the results might contain less items than the limit value.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"simplified": {
"name": "simplified",
"in": "query",
"description": "If `true` or `1` then, the endpoint applies the `fields=url,pageFunctionResult,errorInfo`\nand `unwind=pageFunctionResult` query parameters. This feature is used to emulate simplified results provided by the\nlegacy Apify Crawler product and it's not recommended to use it in new integrations.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"view": {
"name": "view",
"in": "query",
"description": "Defines the view configuration for dataset items based on the schema definition.\nThis parameter determines how the data will be filtered and presented.\nFor complete specification details, see the [dataset schema documentation](/storage/dataset-schema).\n",
"schema": {
"type": "string",
"example": "overview"
}
},
"skipFailedPages": {
"name": "skipFailedPages",
"in": "query",
"description": "If `true` or `1` then, the all the items with errorInfo property will be skipped from the output.\n\nThis feature is here to emulate functionality of API version 1 used for the legacy Apify Crawler product and it's not recommended to use it in new integrations.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"feedTitle": {
"name": "feedTitle",
"in": "query",
"description": "Overrides the auto-generated RSS channel `` element.\nOnly used when `format=rss`. If not provided, the title defaults to `Dataset <label>`.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "Latest posts from r/pasta"
}
},
"feedDescription": {
"name": "feedDescription",
"in": "query",
"description": "Overrides the auto-generated RSS channel `<description>` element.\nOnly used when `format=rss`. If not provided, the description defaults to `Items in dataset with id \"<datasetid>\".`\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "Scraped forum posts"
}
},
"runId": {
"name": "runId",
"in": "path",
"description": "Actor run ID.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "3KH8gEpp4d8uQSe8T"
}
},
"buildResurrect": {
"name": "build",
"in": "query",
"description": "Specifies the Actor build to run. It can be either a build tag or build number.\nBy default, the run is resurrected with the same build it originally used. Specifically,\nif a run was first started with the `latest` tag, which resolves to version `0.0.3` at the\ntime, a run resurrected without this parameter will continue running with `0.0.3`, even if\n`latest` already points to a newer build.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "0.1.234"
}
},
"timeoutResurrect": {
"name": "timeout",
"in": "query",
"description": "Optional timeout for the run, in seconds. By default, the run uses the timeout\nspecified in the run that is being resurrected.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 60
}
},
"memoryResurrect": {
"name": "memory",
"in": "query",
"description": "Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2\nwith a minimum of 128. By default, the run uses the memory limit specified in the run\nthat is being resurrected.\n",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 256
}
},
"restartOnErrorResurrect": {
"name": "restartOnError",
"in": "query",
"description": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"status-2": {
"name": "status",
"in": "query",
"description": "Filter for the run status.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "SUCCEEDED"
}
},
"origin": {
"name": "origin",
"in": "query",
"description": "Filter for the run origin, i.e. the means by which the run was started.",
"style": "form",
"explode": true,
"schema": {
"$ref": "#/components/schemas/RunOrigin"
}
},
"signature": {
"name": "signature",
"in": "query",
"description": "Signature used for the access.",
"required": false,
"style": "form",
"schema": {
"type": "string",
"example": "2wTI46Bg8qWQrV7tavlPI"
}
},
"Content-Encoding": {
"name": "Content-Encoding",
"in": "header",
"description": "Compression encoding of the request body.",
"required": false,
"style": "simple",
"schema": {
"enum": [
"br",
"gzip",
"deflate",
"identity"
],
"type": "string"
}
},
"exclusiveStartKey": {
"name": "exclusiveStartKey",
"in": "query",
"description": "All keys up to this one (including) are skipped from the result.",
"schema": {
"type": "string",
"example": "Ihnsp8YrvJ8102Kj"
}
},
"limit-3": {
"name": "limit",
"in": "query",
"description": "Number of keys to be returned.",
"schema": {
"type": "number",
"format": "int32",
"minimum": 1,
"maximum": 1000,
"default": 1000,
"example": 100
}
},
"collectionKeys": {
"name": "collection",
"in": "query",
"description": "Limit the results to keys that belong to a specific collection from the key-value store schema. The key-value store need to have a schema defined for this parameter to work.",
"schema": {
"type": "string",
"example": "postImages"
}
},
"prefixKeys": {
"name": "prefix",
"in": "query",
"description": "Limit the results to keys that start with a specific prefix.",
"schema": {
"type": "string",
"example": "post-images-"
}
},
"collectionRecords": {
"name": "collection",
"in": "query",
"description": "If specified, only records belonging to a specific collection from the key-value store schema. The key-value store need to have a schema defined for this parameter to work.\n",
"schema": {
"type": "string",
"example": "my-collection"
}
},
"prefixRecords": {
"name": "prefix",
"in": "query",
"description": "If specified, only records whose key starts with the given prefix are included in the archive.\n",
"schema": {
"type": "string",
"example": "my-prefix/"
}
},
"recordKey": {
"name": "recordKey",
"in": "path",
"description": "Key of the record.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "someKey"
}
},
"attachment-2": {
"name": "attachment",
"in": "query",
"description": "If `true` or `1`, the response will be served with `Content-Disposition: attachment` header,\ncausing web browsers to offer downloading HTML records instead of displaying them.\n",
"required": false,
"schema": {
"type": "boolean",
"example": true
}
},
"clientKey": {
"name": "clientKey",
"in": "query",
"description": "A unique identifier of the client accessing the request queue. It must\nbe a string between 1 and 32 characters long. This identifier is used to\ndetermine whether the queue was accessed by multiple clients. If\n`clientKey` is not provided,\nthe system considers this API call to come from a new client. For\ndetails, see the `hadMultipleClients` field returned by the [Get\nhead](#/reference/request-queues/queue-head) operation.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "client-abc"
}
},
"exclusiveStartId": {
"name": "exclusiveStartId",
"in": "query",
"description": "All requests up to this one (including) are skipped from the result. (Deprecated, use `cursor` instead.)",
"deprecated": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "Ihnsp8YrvJ8102Kj"
}
},
"listLimit": {
"name": "limit",
"in": "query",
"description": "Number of keys to be returned. Maximum value is `10000`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 100
}
},
"cursor": {
"name": "cursor",
"in": "query",
"description": "A cursor string for pagination, returned in the previous response as `nextCursor`. Use this to retrieve the next page of requests.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "eyJyZXF1ZXN0SWQiOiI2OFRqQ2RaTDNvM2hiUU0ifQ"
}
},
"filter": {
"name": "filter",
"in": "query",
"description": "Filter requests by their state. Possible values are `locked` and `pending`. You can combine multiple values separated by commas, which will mean the union of these filters – requests matching any of the specified states will be returned. (Not compatible with deprecated `exclusiveStartId` parameter.)",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"locked",
"pending"
]
},
"example": [
"locked"
]
}
},
"forefront": {
"name": "forefront",
"in": "query",
"description": "Determines if request should be added to the head of the queue or to the\nend. Default value is `false` (end of queue).\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "false"
}
},
"contentTypeJson": {
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"const": "application/json"
}
},
"requestId": {
"name": "requestId",
"in": "path",
"description": "Request ID.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "xpsmkDlspokDSmklS"
}
},
"lockSecs": {
"name": "lockSecs",
"in": "query",
"description": "How long the requests will be locked for (in seconds).",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 60
}
},
"lockForefront": {
"name": "forefront",
"in": "query",
"description": "Determines if request should be added to the head of the queue or to the\nend after lock expires.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "false"
}
},
"deleteForefront": {
"name": "forefront",
"in": "query",
"description": "Determines if request should be added to the head of the queue or to the\nend after lock was removed.\n",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "false"
}
},
"headLimit": {
"name": "limit",
"in": "query",
"description": "How many items from queue should be returned.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 100
}
},
"headLockLimit": {
"name": "limit",
"in": "query",
"description": "How many items from the queue should be returned.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"format": "double",
"example": 25,
"maximum": 25
}
},
"stream": {
"name": "stream",
"in": "query",
"description": "If `true` or `1` then the logs will be streamed as long as the run or build is running.\n",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"download": {
"name": "download",
"in": "query",
"description": "If `true` or `1` then the web browser will download the log file rather than open it in a tab.\n",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"raw": {
"name": "raw",
"in": "query",
"description": "If `true` or `1`, the logs will be kept verbatim. By default, the API removes\nANSI escape codes from the logs, keeping only printable characters.\n",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": false
}
},
"gracefully": {
"name": "gracefully",
"in": "query",
"description": "If true passed, the Actor run will abort gracefully.\nIt will send `aborting` and `persistState` event into run and force-stop the run after 30 seconds.\nIt is helpful in cases where you plan to resurrect the run later.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"targetActorId": {
"name": "targetActorId",
"in": "query",
"description": "ID of a target Actor that the run should be transformed into.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "HDSasDasz78YcAPEB"
}
},
"actorTaskId": {
"name": "actorTaskId",
"in": "path",
"description": "Task ID or a tilde-separated owner's username and task's name.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "janedoe~my-task"
}
},
"unnamed": {
"name": "unnamed",
"in": "query",
"description": "If `true` or `1` then all the storages are returned. By default, only\nnamed storages are returned.\n",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"example": true
}
},
"storeId": {
"name": "storeId",
"in": "path",
"description": "Key-value store ID or `username~store-name`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "WkzbQMuFYuamGv3YF"
}
},
"datasetId": {
"name": "datasetId",
"in": "path",
"description": "Dataset ID or `username~dataset-name`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "WkzbQMuFYuamGv3YF"
}
},
"queueId": {
"name": "queueId",
"in": "path",
"description": "Queue ID or `username~queue-name`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "WkzbQMuFYuamGv3YF"
}
},
"webhookId": {
"name": "webhookId",
"in": "path",
"description": "Webhook ID.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "pVJtoTelgYUq4qJOt"
}
},
"scheduleId": {
"name": "scheduleId",
"in": "path",
"description": "Schedule ID.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "asdLZtadYvn4mBZmm"
}
},
"buildOrRunId": {
"name": "buildOrRunId",
"in": "path",
"description": "ID of the Actor build or run.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "HG7ML7M8z78YcAPE"
}
}
},
"schemas": {
"PaginationResponse": {
"title": "PaginationResponse",
"description": "Common pagination fields for list responses.",
"required": [
"total",
"offset",
"limit",
"desc",
"count"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of items available across all pages.",
"minimum": 0,
"examples": [
1
]
},
"offset": {
"type": "integer",
"description": "The starting position for this page of results.",
"minimum": 0,
"examples": [
0
]
},
"limit": {
"type": "integer",
"description": "The maximum number of items returned per page.",
"minimum": 1,
"examples": [
1000
]
},
"desc": {
"type": "boolean",
"description": "Whether the results are sorted in descending order.",
"examples": [
false
]
},
"count": {
"type": "integer",
"description": "The number of items returned in this response.",
"minimum": 0,
"examples": [
1
]
}
}
},
"ActorStats": {
"title": "ActorStats",
"type": "object",
"description": "Usage statistics and Apify Store metrics for the Actor.",
"properties": {
"totalBuilds": {
"type": "integer",
"examples": [
9
],
"description": "The total number of builds of the Actor."
},
"totalRuns": {
"type": "integer",
"examples": [
16
],
"description": "The total number of runs of the Actor."
},
"totalUsers": {
"type": "integer",
"examples": [
6
],
"description": "The total number of Actor users, including its owner."
},
"totalUsers7Days": {
"type": "integer",
"examples": [
2
],
"description": "The number of active users of the Actor in the last 7 days."
},
"totalUsers30Days": {
"type": "integer",
"examples": [
6
],
"description": "The number of active users of the Actor in the last 30 days."
},
"totalUsers90Days": {
"type": "integer",
"examples": [
6
],
"description": "The number of active users of the Actor in the last 90 days."
},
"totalMetamorphs": {
"type": "integer",
"examples": [
2
],
"description": "The total number of times a run of another Actor was [metamorphed](https://docs.apify.com/platform/actors/development/programming-interface/metamorph) into this Actor."
},
"lastRunStartedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-07-08T14:01:05.546Z"
],
"description": "The date and time the most recent run of the Actor started."
},
"actorReviewCount": {
"type": "integer",
"examples": [
69
],
"description": "The number of reviews the Actor has received in Apify Store."
},
"actorReviewRating": {
"type": "number",
"examples": [
4.7
],
"description": "The average rating of the Actor in Apify Store."
},
"bookmarkCount": {
"type": "integer",
"examples": [
1269
],
"description": "The number of users who bookmarked the Actor in Apify Store."
},
"publicActorRunStats30Days": {
"type": "object",
"description": "Run status counts from the last 30 days. Only for public Actors.\nExcludes runs started by the Actor's owner.\n",
"properties": {
"ABORTED": {
"type": "integer",
"examples": [
2542
],
"description": "The number of runs that were aborted."
},
"FAILED": {
"type": "integer",
"examples": [
1234
],
"description": "The number of runs that failed."
},
"SUCCEEDED": {
"type": "integer",
"examples": [
732805
],
"description": "The number of runs that succeeded."
},
"TIMED-OUT": {
"type": "integer",
"examples": [
12556
],
"description": "The number of runs that timed out."
},
"TOTAL": {
"type": "integer",
"examples": [
749137
],
"description": "The total number of runs."
}
}
}
}
},
"ActorShort": {
"title": "ActorShort",
"required": [
"id",
"createdAt",
"modifiedAt",
"name",
"username"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"br9CKmk457"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-10-29T07:34:24.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-10-30T07:34:24.202Z"
]
},
"name": {
"type": "string",
"examples": [
"MyAct"
]
},
"username": {
"type": "string",
"examples": [
"janedoe"
]
},
"title": {
"type": "string",
"examples": [
"Hello World Example"
]
},
"stats": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStats"
},
{
"type": "null"
}
]
}
}
},
"ListOfActors": {
"title": "ListOfActors",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActorShort"
}
}
}
}
]
},
"ListOfActorsResponse": {
"title": "ListOfActorsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfActors"
}
}
},
"ErrorType": {
"title": "ErrorType",
"type": "string",
"description": "Machine-processable error type identifier.",
"enum": [
"3d-secure-auth-failed",
"access-right-already-exists",
"action-not-found",
"actor-already-rented",
"actor-can-not-be-rented",
"actor-disabled",
"actor-is-not-rented",
"actor-memory-limit-exceeded",
"actor-name-exists-new-owner",
"actor-name-not-unique",
"actor-not-found",
"actor-not-github-actor",
"actor-not-public",
"actor-permission-level-not-supported-for-agentic-payments",
"actor-review-already-exists",
"actor-run-failed",
"actor-standby-not-supported-for-agentic-payments",
"actor-task-name-not-unique",
"agentic-payment-info-retrieval-error",
"agentic-payment-information-missing",
"agentic-payment-insufficient-amount",
"agentic-payment-provider-internal-error",
"agentic-payment-provider-unauthorized",
"airtable-webhook-deprecated",
"already-subscribed-to-paid-actor",
"apify-plan-required-to-use-paid-actor",
"apify-signup-not-allowed",
"auth-method-not-supported",
"authorization-server-not-found",
"auto-issue-date-invalid",
"background-check-required",
"billing-system-error",
"black-friday-plan-expired",
"braintree-error",
"braintree-not-linked",
"braintree-operation-timed-out",
"braintree-unsupported-currency",
"build-not-found",
"build-outdated",
"cannot-add-apify-events-to-ppe-actor",
"cannot-add-multiple-pricing-infos",
"cannot-add-pricing-info-that-alters-past",
"cannot-add-second-future-pricing-info",
"cannot-build-actor-from-webhook",
"cannot-change-billing-interval",
"cannot-change-owner",
"cannot-charge-apify-event",
"cannot-charge-non-pay-per-event-actor",
"cannot-comment-as-other-user",
"cannot-copy-actor-task",
"cannot-create-payout",
"cannot-create-public-actor",
"cannot-create-tax-transaction",
"cannot-delete-critical-actor",
"cannot-delete-invoice",
"cannot-delete-paid-actor",
"cannot-disable-one-time-event-for-apify-start-event",
"cannot-disable-organization-with-enabled-members",
"cannot-disable-user-with-subscription",
"cannot-link-oauth-to-unverified-email",
"cannot-metamorph-to-pay-per-result-actor",
"cannot-modify-actor-pricing-too-frequently",
"cannot-modify-actor-pricing-with-immediate-effect",
"cannot-monetize-without-payout-billing-info",
"cannot-override-paid-actor-trial",
"cannot-permanently-delete-subscription",
"cannot-publish-actor",
"cannot-publish-actor-task",
"cannot-reduce-last-full-token",
"cannot-reimburse-more-than-original-charge",
"cannot-reimburse-non-rental-charge",
"cannot-remove-own-actor-from-recently-used",
"cannot-remove-payment-method",
"cannot-remove-pricing-info",
"cannot-remove-running-run",
"cannot-remove-user-with-public-actors",
"cannot-remove-user-with-subscription",
"cannot-remove-user-with-unpaid-invoice",
"cannot-rename-env-var",
"cannot-rent-paid-actor",
"cannot-review-own-actor",
"cannot-set-access-rights-for-owner",
"cannot-set-is-status-message-terminal",
"cannot-unpublish-critical-actor",
"cannot-unpublish-paid-actor",
"cannot-unpublish-profile",
"cannot-update-invoice-field",
"concurrent-runs-limit-exceeded",
"concurrent-update-detected",
"conference-token-not-found",
"content-encoding-forbidden-for-html",
"coupon-already-redeemed",
"coupon-expired",
"coupon-for-new-customers",
"coupon-for-subscribed-users",
"coupon-limits-are-in-conflict-with-current-limits",
"coupon-max-number-of-redemptions-reached",
"coupon-not-found",
"coupon-not-unique",
"coupons-disabled",
"create-github-issue-not-allowed",
"creator-plan-not-available",
"cron-expression-invalid",
"daily-ai-token-limit-exceeded",
"daily-publication-limit-exceeded",
"dataset-does-not-have-fields-schema",
"dataset-does-not-have-schema",
"dataset-locked",
"dataset-schema-invalid",
"dcr-not-supported",
"default-dataset-not-found",
"deleting-default-build",
"deleting-unfinished-build",
"email-already-taken",
"email-already-taken-removed-user",
"email-domain-not-allowed-for-coupon",
"email-invalid",
"email-not-allowed",
"email-not-valid",
"email-update-too-soon",
"elevated-permissions-needed",
"env-var-already-exists",
"exchange-rate-fetch-failed",
"expired-conference-token",
"failed-to-charge-user",
"final-invoice-negative",
"full-permission-actor-blocked-for-admin",
"full-permission-actor-not-approved",
"github-branch-empty",
"github-issue-already-exists",
"github-public-key-not-found",
"github-repository-not-found",
"github-signature-does-not-match-payload",
"github-user-not-authorized-for-issues",
"gmail-not-allowed",
"id-does-not-match",
"incompatible-billing-interval",
"incomplete-payout-billing-info",
"inconsistent-currencies",
"incorrect-pricing-modifier-prefix",
"input-json-invalid-characters",
"input-json-not-object",
"input-json-too-long",
"input-update-collision",
"insufficient-permissions",
"insufficient-permissions-to-change-field",
"insufficient-security-measures",
"insufficient-tax-country-evidence",
"integration-auth-error",
"internal-server-error",
"invalid-billing-info",
"invalid-billing-period-for-payout",
"invalid-build",
"invalid-client-key",
"invalid-collection",
"invalid-conference-login-password",
"invalid-content-type-header",
"invalid-credentials",
"invalid-git-auth-token",
"invalid-github-issue-url",
"invalid-header",
"invalid-id",
"invalid-idempotency-key",
"invalid-input",
"invalid-input-schema",
"invalid-invoice",
"invalid-invoice-type",
"invalid-issue-date",
"invalid-label-params",
"invalid-main-account-user-id",
"invalid-oauth-app",
"invalid-oauth-scope",
"invalid-one-time-invoice",
"invalid-parameter",
"invalid-payout-status",
"invalid-picture-url",
"invalid-record-key",
"invalid-request",
"invalid-resource-type",
"invalid-signature",
"invalid-subscription-plan",
"invalid-tax-number",
"invalid-tax-number-format",
"invalid-token",
"invalid-token-type",
"invalid-two-factor-code",
"invalid-two-factor-code-or-recovery-code",
"invalid-two-factor-recovery-code",
"invalid-username",
"invalid-value",
"invitation-invalid-resource-type",
"invitation-no-longer-valid",
"invoice-canceled",
"invoice-cannot-be-refunded-due-to-too-high-amount",
"invoice-incomplete",
"invoice-is-draft",
"invoice-locked",
"invoice-must-be-buffer",
"invoice-not-canceled",
"invoice-not-draft",
"invoice-not-found",
"invoice-outdated",
"invoice-paid-already",
"issue-already-connected-to-github",
"issue-not-found",
"issues-bad-request",
"issuer-not-registered",
"job-finished",
"label-already-linked",
"last-api-token",
"limit-reached",
"max-items-must-be-greater-than-zero",
"max-metamorphs-exceeded",
"max-total-charge-usd-below-minimum",
"max-total-charge-usd-must-be-greater-than-zero",
"method-not-allowed",
"migration-disabled",
"missing-actor-rights",
"missing-api-token",
"missing-billing-info",
"missing-line-items",
"missing-payment-date",
"missing-payout-billing-info",
"missing-proxy-password",
"missing-reporting-fields",
"missing-resource-name",
"missing-settings",
"missing-username",
"monthly-usage-limit-too-low",
"more-than-one-update-not-allowed",
"multiple-records-found",
"must-be-admin",
"name-not-unique",
"next-runtime-computation-failed",
"no-columns-in-exported-dataset",
"no-payment-attempt-for-refund-found",
"no-payment-method-available",
"no-team-account-seats-available",
"non-temporary-email",
"not-enough-usage-to-run-paid-actor",
"not-implemented",
"not-supported-currencies",
"o-auth-service-already-connected",
"o-auth-service-not-connected",
"oauth-resource-access-failed",
"one-time-invoice-already-marked-paid",
"only-drafts-can-be-deleted",
"operation-canceled",
"operation-not-allowed",
"operation-timed-out",
"organization-cannot-own-itself",
"organization-role-not-found",
"overlapping-payout-billing-periods",
"own-token-required",
"page-not-found",
"param-not-one-of",
"parameter-required",
"parameters-mismatched",
"password-reset-email-already-sent",
"password-reset-token-expired",
"pay-as-you-go-without-monthly-interval",
"payment-attempt-status-message-required",
"payout-already-paid",
"payout-canceled",
"payout-invalid-state",
"payout-must-be-approved-to-be-marked-paid",
"payout-not-found",
"payout-number-already-exists",
"phone-number-invalid",
"phone-number-landline",
"phone-number-opted-out",
"phone-verification-disabled",
"platform-feature-disabled",
"price-overrides-validation-failed",
"pricing-model-not-supported",
"promotional-plan-not-available",
"proxy-auth-ip-not-unique",
"public-actor-disabled",
"query-timeout",
"quoted-price-outdated",
"rate-limit-exceeded",
"recaptcha-invalid",
"recaptcha-required",
"record-not-found",
"record-not-public",
"record-or-token-not-found",
"record-too-large",
"redirect-uri-mismatch",
"reduced-plan-not-available",
"rental-charge-already-reimbursed",
"rental-not-allowed",
"request-aborted-prematurely",
"request-handled-or-locked",
"request-id-invalid",
"request-queue-duplicate-requests",
"request-too-large",
"requested-dataset-view-does-not-exist",
"resume-token-expired",
"run-failed",
"run-input-body-not-valid-json",
"run-timeout-exceeded",
"russia-is-evil",
"same-user",
"schedule-actor-not-found",
"schedule-actor-task-not-found",
"schedule-name-not-unique",
"schema-validation",
"schema-validation-error",
"schema-validation-failed",
"service-worker-registration-not-allowed",
"sign-up-method-not-allowed",
"slack-integration-not-custom",
"socket-closed",
"socket-destroyed",
"store-schema-invalid",
"store-terms-not-accepted",
"stripe-enabled",
"stripe-generic-decline",
"stripe-not-enabled",
"stripe-not-enabled-for-user",
"tagged-build-required",
"tax-country-invalid",
"tax-number-invalid",
"tax-number-validation-failed",
"taxamo-call-failed",
"taxamo-request-failed",
"testing-error",
"token-not-provided",
"too-few-versions",
"too-many-actor-tasks",
"too-many-actors",
"too-many-labels-on-resource",
"too-many-mcp-connectors",
"too-many-o-auth-apps",
"too-many-organizations",
"too-many-requests",
"too-many-schedules",
"too-many-ui-access-keys",
"too-many-user-labels",
"too-many-values",
"too-many-versions",
"too-many-webhooks",
"unexpected-route",
"unknown-build-tag",
"unknown-payment-provider",
"unsubscribe-token-invalid",
"unsupported-actor-pricing-model-for-agentic-payments",
"unsupported-content-encoding",
"unsupported-file-type-for-issue",
"unsupported-file-type-image-expected",
"unsupported-file-type-text-or-json-expected",
"unsupported-permission",
"upcoming-subscription-bill-not-up-to-date",
"user-already-exists",
"user-already-verified",
"user-creates-organizations-too-fast",
"user-disabled",
"user-email-is-disposable",
"user-email-not-set",
"user-email-not-verified",
"user-has-no-subscription",
"user-integration-not-found",
"user-is-already-invited",
"user-is-already-organization-member",
"user-is-not-member-of-organization",
"user-is-not-organization",
"user-is-organization",
"user-is-organization-owner",
"user-is-removed",
"user-not-found",
"user-not-logged-in",
"user-not-verified",
"user-or-token-not-found",
"user-plan-not-allowed-for-coupon",
"user-problem-with-card",
"user-record-not-found",
"username-already-taken",
"username-missing",
"username-not-allowed",
"username-removal-forbidden",
"username-required",
"verification-email-already-sent",
"verification-token-expired",
"version-already-exists",
"versions-size-exceeded",
"weak-password",
"x402-agentic-payment-already-finalized",
"x402-agentic-payment-insufficient-amount",
"x402-agentic-payment-malformed-token",
"x402-agentic-payment-settlement-failed",
"x402-agentic-payment-settlement-in-progress",
"x402-agentic-payment-settlement-stuck",
"x402-agentic-payment-unauthorized",
"x402-payment-required",
"zero-invoice"
]
},
"ErrorDetail": {
"title": "ErrorDetail",
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/ErrorType"
},
"message": {
"type": "string",
"description": "Human-readable error message describing what went wrong."
}
}
},
"ErrorResponse": {
"title": "ErrorResponse",
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorDetail"
}
}
},
"VersionSourceType": {
"title": "VersionSourceType",
"enum": [
"SOURCE_FILES",
"GIT_REPO",
"TARBALL",
"GITHUB_GIST",
"SOURCE_CODE"
],
"type": "string"
},
"EnvVar": {
"title": "EnvVar",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"MY_ENV_VAR"
],
"description": "The name of the environment variable."
},
"value": {
"type": "string",
"examples": [
"my-value"
],
"description": "The value of the environment variable. If `isSecret` is `true`, this value isn't returned by the API."
},
"isSecret": {
"type": [
"boolean",
"null"
],
"examples": [
false
],
"description": "Whether the environment variable is encrypted. Secret values aren't returned by the API."
}
}
},
"SourceCodeFileFormat": {
"type": "string",
"enum": [
"BASE64",
"TEXT"
],
"examples": [
"TEXT"
]
},
"SourceCodeFile": {
"title": "SourceCodeFile",
"type": "object",
"description": "Represents a single file in the Actor's source code.",
"required": [
"name"
],
"properties": {
"format": {
"$ref": "#/components/schemas/SourceCodeFileFormat",
"description": "Format of the file's content, `TEXT` for plain text and `BASE64` for encoded content."
},
"content": {
"type": "string",
"examples": [
"console.log('This is the main.js file');"
],
"description": "The contents of the file. Interpreted based on the value of `format`."
},
"name": {
"type": "string",
"examples": [
"src/main.js"
],
"description": "The path of the file relative to the Actor's root directory."
}
}
},
"SourceCodeFolder": {
"title": "SourceCodeFolder",
"description": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`.\n",
"type": "object",
"required": [
"name",
"folder"
],
"properties": {
"name": {
"type": "string",
"description": "The path of the folder relative to the Actor's root directory.",
"examples": [
"src/utils"
]
},
"folder": {
"type": "boolean",
"description": "Whether it's a folder. Distinguishes folders from files.",
"examples": [
true
]
}
}
},
"VersionSourceFiles": {
"title": "VersionSourceFiles",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/SourceCodeFile"
},
{
"$ref": "#/components/schemas/SourceCodeFolder"
}
]
}
},
"Version": {
"title": "Version",
"type": "object",
"required": [
"versionNumber",
"sourceType"
],
"properties": {
"versionNumber": {
"type": "string",
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$",
"examples": [
"0.0"
],
"description": "The version number of the Actor. Two numbers separated by a dot, that represent the `MAJOR.MINOR` part of the semantic versioning."
},
"sourceType": {
"anyOf": [
{
"$ref": "#/components/schemas/VersionSourceType"
},
{
"type": "null"
}
],
"description": "Where the source code of the version lives."
},
"envVars": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvVar"
}
},
{
"type": "null"
}
],
"description": "Environment variables for the version."
},
"applyEnvVarsToBuild": {
"type": [
"boolean",
"null"
],
"examples": [
false
],
"description": "Whether to inject the environment variables at build time."
},
"buildTag": {
"type": [
"string",
"null"
],
"examples": [
"latest"
],
"description": "The tag name to apply to a successful build of this version. Can be `null` when the version has no build tag."
},
"sourceFiles": {
"$ref": "#/components/schemas/VersionSourceFiles",
"description": "Applies when the `sourceType` is `SOURCE_FILES`. Represents the Actor's file structure as an array of files and folders."
},
"gitRepoUrl": {
"type": [
"string",
"null"
],
"description": "URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`."
},
"tarballUrl": {
"type": [
"string",
"null"
],
"description": "URL to download the source code from as a tarball or ZIP file. Applies when the `sourceType` is `TARBALL`."
},
"gitHubGistUrl": {
"type": [
"string",
"null"
],
"description": "URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`."
}
}
},
"ActorPermissionLevel": {
"type": "string",
"description": "Determines the permission level that the Actor requires to run. For details, see [Actor permissions](https://docs.apify.com/platform/actors/development/permissions).\n",
"enum": [
"LIMITED_PERMISSIONS",
"FULL_PERMISSIONS"
],
"examples": [
"LIMITED_PERMISSIONS"
]
},
"DefaultRunOptions": {
"title": "DefaultRunOptions",
"type": "object",
"description": "The default settings applied to an Actor run. Can be overridden elsewhere.",
"properties": {
"build": {
"type": "string",
"examples": [
"latest"
],
"description": "Which build to run. Either a build tag or a version number."
},
"timeoutSecs": {
"type": "integer",
"examples": [
3600
],
"description": "Timeout in seconds. 0 if no timeout."
},
"memoryMbytes": {
"type": "integer",
"examples": [
2048
],
"description": "In MB, the amount of memory allocated to the run."
},
"restartOnError": {
"type": "boolean",
"examples": [
false
],
"description": "Whether to automatically restart the run if it fails."
},
"maxItems": {
"type": [
"integer",
"null"
],
"description": "Maximum number of items the run might produce."
},
"forcePermissionLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorPermissionLevel"
},
{
"type": "null"
}
]
}
}
},
"ActorStandby": {
"title": "ActorStandby",
"type": "object",
"properties": {
"isEnabled": {
"type": [
"boolean",
"null"
],
"description": "Whether standby mode is enabled for the Actor."
},
"desiredRequestsPerActorRun": {
"type": [
"integer",
"null"
],
"description": "Target number of concurrent HTTP requests a single run is configured to handle."
},
"maxRequestsPerActorRun": {
"type": [
"integer",
"null"
],
"description": "Maximum number of concurrent HTTP requests that can be routed to a single run."
},
"idleTimeoutSecs": {
"type": [
"integer",
"null"
],
"description": "In seconds, how long a run can stay idle without incoming requests before it's terminated."
},
"build": {
"type": [
"string",
"null"
],
"description": "Which build to run in standby mode. Either a build tag or a version number."
},
"memoryMbytes": {
"type": [
"integer",
"null"
],
"description": "In MB, the amount of memory allocated to the run."
},
"disableStandbyFieldsOverride": {
"type": [
"boolean",
"null"
],
"description": "If `true`, prevents the standby mode configuration from being overridden elsewhere."
},
"shouldPassActorInput": {
"type": [
"boolean",
"null"
],
"description": "Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input."
}
}
},
"ExampleRunInput": {
"title": "ExampleRunInput",
"type": "object",
"properties": {
"body": {
"type": "string",
"example": "{ \"helloWorld\": 123 }",
"description": "Sample input, serialized as a string."
},
"contentType": {
"type": "string",
"examples": [
"application/json; charset=utf-8"
],
"description": "MIME type of `body`."
}
}
},
"CreateActorRequest": {
"title": "CreateActorRequest",
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"examples": [
"instagram-scraper"
],
"description": "The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account."
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"This scraper extracts posts and comments from Instagram."
],
"description": "Short description of the Actor, displayed in Apify Store and Console."
},
"title": {
"type": [
"string",
"null"
],
"examples": [
"Instagram scraper"
],
"description": "Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO."
},
"isPublic": {
"type": [
"boolean",
"null"
],
"examples": [
false
],
"description": "Whether the Actor is available to users in Apify Store. If `false`, the Actor is private and only visible to you."
},
"seoTitle": {
"type": [
"string",
"null"
],
"examples": [
"Free Instagram scraper"
],
"description": "Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console. Recommended length is 40-50 characters."
},
"seoDescription": {
"type": [
"string",
"null"
],
"examples": [
"The best scraper for Instagram"
],
"description": "Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters."
},
"restartOnError": {
"type": "boolean",
"examples": [
false
],
"deprecated": true
},
"versions": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
}
},
{
"type": "null"
}
],
"description": "An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration."
},
"categories": {
"type": [
"array",
"null"
],
"examples": [
[
"SOCIAL_MEDIA"
]
],
"items": {
"type": "string"
},
"description": "A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options."
},
"defaultRunOptions": {
"$ref": "#/components/schemas/DefaultRunOptions"
},
"actorStandby": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStandby"
},
{
"type": "null"
}
],
"description": "The configuration of the Actor's standby mode. For details, see [Standby mode](https://docs.apify.com/platform/actors/development/programming-interface/standby)."
},
"exampleRunInput": {
"anyOf": [
{
"$ref": "#/components/schemas/ExampleRunInput"
},
{
"type": "null"
}
],
"description": "Sample input payload that demonstrates what a typical run input for an Actor looks like. Used when no explicit input for a run is provided."
},
"isDeprecated": {
"type": [
"boolean",
"null"
],
"description": "Whether the Actor is deprecated."
}
}
},
"CommonActorPricingInfo": {
"title": "CommonActorPricingInfo",
"type": "object",
"required": [
"apifyMarginPercentage",
"createdAt",
"startedAt"
],
"properties": {
"apifyMarginPercentage": {
"type": "number",
"examples": [
0.2
],
"description": "Apify's share of the revenue generated under this pricing info record, as a fraction between 0 and 1. Set by the Apify platform.\n"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When this pricing info record has been created"
},
"startedAt": {
"type": "string",
"format": "date-time",
"description": "Since when is this pricing info record effective for a given Actor"
},
"notifiedAboutFutureChangeAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"x-internal": true
},
"notifiedAboutChangeAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"x-internal": true
},
"reasonForChange": {
"type": [
"string",
"null"
],
"x-internal": true
},
"isPriceChangeNotificationSuppressed": {
"type": "boolean",
"x-internal": true
},
"forceContainsSignificantPriceChange": {
"type": "boolean",
"x-internal": true
}
}
},
"TieredPricingPerEventEntry": {
"title": "TieredPricingPerEventEntry",
"description": "A single tier's price-per-event entry.",
"type": "object",
"required": [
"tieredEventPriceUsd"
],
"properties": {
"tieredEventPriceUsd": {
"type": "number",
"description": "Price per event in USD for this tier."
}
}
},
"TieredPricingPerEvent": {
"title": "TieredPricingPerEvent",
"description": "Tiered price-per-event pricing for a single charge event, keyed by subscription tier (e.g. `FREE`, `BRONZE`,\n`SILVER`, `GOLD`, `PLATINUM`, `DIAMOND`). The actual price applied is resolved from the user's tier.\n",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TieredPricingPerEventEntry"
}
},
"ActorChargeEvent": {
"title": "ActorChargeEvent",
"description": "Definition of a single chargeable event for a pay-per-event Actor. Each event is either flat-priced\n(`eventPriceUsd` is set) or tier-priced (`eventTieredPricingUsd` is set); the two are mutually exclusive.\n",
"type": "object",
"required": [
"eventTitle",
"eventDescription"
],
"properties": {
"eventTitle": {
"type": "string",
"description": "Human-readable title shown to users in the billing UI."
},
"eventDescription": {
"type": "string",
"description": "Human-readable description of what triggers this event."
},
"eventPriceUsd": {
"type": "number",
"description": "Flat price per event in USD. Present only for non-tiered events. Mutually exclusive with `eventTieredPricingUsd`.\n"
},
"eventTieredPricingUsd": {
"$ref": "#/components/schemas/TieredPricingPerEvent"
},
"isPrimaryEvent": {
"type": "boolean",
"description": "Whether this event is the Actor's primary chargeable event."
},
"isOneTimeEvent": {
"type": "boolean",
"description": "Whether this event can only be charged once per Actor run."
}
}
},
"PayPerEventActorPricingInfo": {
"title": "PayPerEventActorPricingInfo",
"allOf": [
{
"$ref": "#/components/schemas/CommonActorPricingInfo"
},
{
"type": "object",
"required": [
"pricingModel",
"pricingPerEvent"
],
"properties": {
"pricingModel": {
"type": "string",
"const": "PAY_PER_EVENT"
},
"pricingPerEvent": {
"type": "object",
"properties": {
"actorChargeEvents": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ActorChargeEvent"
}
}
}
},
"minimalMaxTotalChargeUsd": {
"type": [
"number",
"null"
]
}
}
}
]
},
"TieredPricingPerDatasetItemEntry": {
"title": "TieredPricingPerDatasetItemEntry",
"description": "A single tier's price-per-dataset-item entry.",
"type": "object",
"required": [
"tieredPricePerUnitUsd"
],
"properties": {
"tieredPricePerUnitUsd": {
"type": "number",
"description": "Price per unit in USD for this tier."
}
}
},
"TieredPricingPerDatasetItem": {
"title": "TieredPricingPerDatasetItem",
"description": "Tiered price-per-dataset-item pricing, keyed by subscription tier (e.g. `FREE`, `BRONZE`, `SILVER`, `GOLD`,\n`PLATINUM`, `DIAMOND`). The actual price applied to a run is resolved from the user's tier.\n",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TieredPricingPerDatasetItemEntry"
}
},
"PricePerDatasetItemActorPricingInfo": {
"title": "PricePerDatasetItemActorPricingInfo",
"allOf": [
{
"$ref": "#/components/schemas/CommonActorPricingInfo"
},
{
"type": "object",
"required": [
"pricingModel",
"unitName"
],
"properties": {
"pricingModel": {
"type": "string",
"const": "PRICE_PER_DATASET_ITEM"
},
"unitName": {
"type": "string",
"description": "Name of the unit that is being charged"
},
"pricePerUnitUsd": {
"type": "number",
"description": "Price per unit in USD. Mutually exclusive with `tieredPricing` - exactly one of the two is present\non a pricing record.\n"
},
"tieredPricing": {
"$ref": "#/components/schemas/TieredPricingPerDatasetItem"
}
}
}
]
},
"FlatPricePerMonthActorPricingInfo": {
"title": "FlatPricePerMonthActorPricingInfo",
"allOf": [
{
"$ref": "#/components/schemas/CommonActorPricingInfo"
},
{
"type": "object",
"required": [
"pricingModel",
"pricePerUnitUsd",
"trialMinutes"
],
"properties": {
"pricingModel": {
"type": "string",
"const": "FLAT_PRICE_PER_MONTH"
},
"trialMinutes": {
"type": "integer",
"description": "For how long this Actor can be used for free in trial period"
},
"pricePerUnitUsd": {
"type": "number",
"description": "Monthly flat price in USD"
}
}
}
]
},
"FreeActorPricingInfo": {
"title": "FreeActorPricingInfo",
"allOf": [
{
"$ref": "#/components/schemas/CommonActorPricingInfo"
},
{
"type": "object",
"required": [
"pricingModel"
],
"properties": {
"pricingModel": {
"type": "string",
"const": "FREE"
}
}
}
]
},
"ActorRunPricingInfo": {
"title": "ActorRunPricingInfo",
"discriminator": {
"propertyName": "pricingModel",
"mapping": {
"PAY_PER_EVENT": "#/components/schemas/PayPerEventActorPricingInfo",
"PRICE_PER_DATASET_ITEM": "#/components/schemas/PricePerDatasetItemActorPricingInfo",
"FLAT_PRICE_PER_MONTH": "#/components/schemas/FlatPricePerMonthActorPricingInfo",
"FREE": "#/components/schemas/FreeActorPricingInfo"
}
},
"oneOf": [
{
"$ref": "#/components/schemas/PayPerEventActorPricingInfo"
},
{
"$ref": "#/components/schemas/PricePerDatasetItemActorPricingInfo"
},
{
"$ref": "#/components/schemas/FlatPricePerMonthActorPricingInfo"
},
{
"$ref": "#/components/schemas/FreeActorPricingInfo"
}
]
},
"TaggedBuildInfo": {
"title": "TaggedBuildInfo",
"description": "Information about a tagged build.",
"type": "object",
"properties": {
"buildId": {
"type": "string",
"description": "The ID of the build associated with this tag.",
"examples": [
"z2EryhbfhgSyqj6Hn"
]
},
"buildNumber": {
"type": [
"string",
"null"
],
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$",
"description": "The build number/version string. Can be `null` for legacy builds that lack a valid build number.",
"examples": [
"0.0.2"
]
},
"buildNumberInt": {
"type": "integer",
"description": "The build number encoded as a single integer.",
"examples": [
42
]
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The timestamp when the build finished.",
"examples": [
"2019-06-10T11:15:49.286Z"
]
}
}
},
"TaggedBuilds": {
"title": "TaggedBuilds",
"description": "A dictionary mapping build tag names (e.g., \"latest\", \"beta\") to their build information.",
"type": "object",
"additionalProperties": {
"anyOf": [
{
"$ref": "#/components/schemas/TaggedBuildInfo"
},
{
"type": "null"
}
]
},
"example": {
"latest": {
"buildId": "z2EryhbfhgSyqj6Hn",
"buildNumber": "0.0.2",
"finishedAt": "2019-06-10T11:15:49.286Z"
},
"beta": {
"buildId": "abc123def456",
"buildNumber": "1.0.5",
"finishedAt": "2019-07-15T14:30:00.000Z"
}
}
},
"ActorNotice": {
"title": "ActorNotice",
"type": [
"string",
"null"
],
"description": "A warning displayed on the Actor's page in Apify Store and Console. Can be set by the Actor's developer or automatically by Apify's quality checks.",
"enum": [
"NONE",
"RESIDENTIAL_PROXY_REQUIRED",
"UNDER_MAINTENANCE",
null
],
"examples": [
"UNDER_MAINTENANCE"
]
},
"Actor": {
"title": "Actor",
"required": [
"id",
"userId",
"name",
"username",
"isPublic",
"createdAt",
"modifiedAt",
"stats",
"versions",
"defaultRunOptions"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"zdc3Pyhyz3m8vjDeM"
],
"description": "The ID of the Actor."
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
],
"description": "The ID of the user who owns the Actor."
},
"name": {
"type": "string",
"examples": [
"google-search-extractor"
],
"description": "The name of the Actor."
},
"username": {
"type": "string",
"examples": [
"compass"
],
"description": "The username of the Actor owner."
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"Extract data from hundreds of places fast."
],
"description": "Short description of the Actor, displayed in Apify Store and Console."
},
"restartOnError": {
"type": "boolean",
"examples": [
false
],
"deprecated": true
},
"isPublic": {
"type": "boolean",
"examples": [
false
],
"description": "Whether the Actor is available to users in Apify Store."
},
"actorPermissionLevel": {
"$ref": "#/components/schemas/ActorPermissionLevel"
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-07-08T11:27:57.401Z"
],
"description": "The date and time the Actor was created. Follows the ISO 8601 format."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-07-08T14:01:05.546Z"
],
"description": "The date and time the Actor was last modified. Follows the ISO 8601 format."
},
"stats": {
"$ref": "#/components/schemas/ActorStats"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
},
"description": "An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration."
},
"pricingInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActorRunPricingInfo"
}
},
"defaultRunOptions": {
"$ref": "#/components/schemas/DefaultRunOptions"
},
"exampleRunInput": {
"anyOf": [
{
"$ref": "#/components/schemas/ExampleRunInput"
},
{
"type": "null"
}
]
},
"isDeprecated": {
"type": [
"boolean",
"null"
],
"examples": [
false
],
"description": "Whether the Actor is deprecated."
},
"deploymentKey": {
"type": "string",
"examples": [
"ssh-rsa AAAA ..."
],
"description": "The Actor's public SSH key, used as a deployment key for private Git repositories."
},
"title": {
"type": [
"string",
"null"
],
"examples": [
"Google Search Extractor"
],
"description": "Human-readable name of the Actor, displayed in Apify Store and Console."
},
"taggedBuilds": {
"anyOf": [
{
"$ref": "#/components/schemas/TaggedBuilds"
},
{
"type": "null"
}
]
},
"actorStandby": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStandby"
},
{
"type": "null"
}
]
},
"readmeSummary": {
"type": "string",
"description": "An AI-generated Markdown summary of the Actor's README, optimized for search and AI agents. Contains an overview and a list of use cases. Generated only for public Actors."
},
"seoTitle": {
"type": [
"string",
"null"
],
"examples": [
"Web Scraper"
],
"description": "Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console."
},
"seoDescription": {
"type": [
"string",
"null"
],
"examples": [
"Crawls websites using Chrome and extracts data from pages using JavaScript."
],
"description": "Description of the Actor to display by search engines such as Google."
},
"pictureUrl": {
"type": [
"string",
"null"
],
"examples": [
"https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png"
],
"description": "URL of the Actor's icon, displayed on the Actor's page in Apify Store and Console."
},
"standbyUrl": {
"type": [
"string",
"null"
],
"examples": [
"https://jane35--my-actor.apify.actor"
],
"description": "URL for sending requests to the Actor in Standby mode.\n`null` if the Standby mode isn't enabled.\n"
},
"notice": {
"$ref": "#/components/schemas/ActorNotice"
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"DEVELOPER_TOOLS",
"OPEN_SOURCE"
]
],
"description": "A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options."
},
"isCritical": {
"type": "boolean",
"examples": [
false
],
"description": "Whether the Actor is maintained by Apify."
},
"isGeneric": {
"type": "boolean",
"examples": [
false
],
"description": "Whether the Actor is intended for developers. Set by Apify."
},
"isSourceCodeHidden": {
"type": "boolean",
"default": true,
"examples": [
true
],
"description": "Whether the Actor's source files are hidden on its detail page."
},
"hasNoDataset": {
"type": "boolean",
"examples": [
false
],
"description": "Whether the Actor stores results in a dataset. Set by Apify."
}
}
},
"ActorResponse": {
"title": "ActorResponse",
"description": "Response containing Actor data.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Actor"
}
}
},
"CreateOrUpdateVersionRequest": {
"title": "CreateOrUpdateVersionRequest",
"type": "object",
"properties": {
"versionNumber": {
"type": [
"string",
"null"
],
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$",
"examples": [
"1.6"
],
"description": "The version number of the Actor. Two numbers separated by a dot, that represent the `MAJOR.MINOR` part of the semantic versioning."
},
"sourceType": {
"anyOf": [
{
"$ref": "#/components/schemas/VersionSourceType"
},
{
"type": "null"
}
],
"description": "Where the source code of the version lives."
},
"envVars": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvVar"
}
},
{
"type": "null"
}
],
"description": "Environment variables for the version."
},
"applyEnvVarsToBuild": {
"type": [
"boolean",
"null"
],
"examples": [
false
],
"description": "Whether to inject the environment variables at build time."
},
"buildTag": {
"type": [
"string",
"null"
],
"examples": [
"latest"
],
"description": "The tag name to apply to a successful build of this version. Can be `null` when the version has no build tag."
},
"sourceFiles": {
"$ref": "#/components/schemas/VersionSourceFiles",
"description": "Applies when the `sourceType` is `SOURCE_FILES`. Represents the Actor's file structure as an array of files and folders."
},
"gitRepoUrl": {
"type": [
"string",
"null"
],
"description": "URL of the Git repository to clone the source code from. Applies when the `sourceType` is `GIT_REPO`."
},
"tarballUrl": {
"type": [
"string",
"null"
],
"description": "URL of the tarball to download the source code from. Applies when the `sourceType` is `TARBALL`."
},
"gitHubGistUrl": {
"type": [
"string",
"null"
],
"description": "URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`."
}
}
},
"BuildTag": {
"title": "BuildTag",
"type": [
"object",
"null"
],
"description": "The name of the build tag.",
"required": [
"buildId"
],
"properties": {
"buildId": {
"type": "string",
"description": "The ID of the build to assign to the tag."
}
}
},
"UpdateActorRequest": {
"title": "UpdateActorRequest",
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"instagram-scraper"
],
"description": "The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account."
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"This scraper extracts posts and comments from Instagram."
],
"description": "Short description of the Actor, displayed in Apify Store and Console."
},
"isPublic": {
"type": "boolean",
"examples": [
false
],
"description": "Whether the Actor is available to users in Apify Store. If `false`, the Actor is private and only visible to you."
},
"actorPermissionLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorPermissionLevel"
},
{
"type": "null"
}
]
},
"seoTitle": {
"type": [
"string",
"null"
],
"examples": [
"Free Instagram scraper"
],
"description": "Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console. Recommended length is 40-50 characters."
},
"seoDescription": {
"type": [
"string",
"null"
],
"examples": [
"The best scraper for Instagram"
],
"description": "Description of the Actor to display by search engines such as Google. Recommended length is 140-156 characters."
},
"title": {
"type": [
"string",
"null"
],
"examples": [
"Instagram scraper"
],
"description": "Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO."
},
"restartOnError": {
"type": "boolean",
"examples": [
false
],
"deprecated": true
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOrUpdateVersionRequest"
},
"description": "An array of `Version` objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration."
},
"pricingInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActorRunPricingInfo"
}
},
"categories": {
"type": [
"array",
"null"
],
"examples": [
[
"SOCIAL_MEDIA"
]
],
"items": {
"type": "string"
},
"description": "A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options."
},
"defaultRunOptions": {
"anyOf": [
{
"$ref": "#/components/schemas/DefaultRunOptions"
},
{
"type": "null"
}
],
"description": "The default settings applied to an Actor run. Can be overridden by the user."
},
"taggedBuilds": {
"type": [
"object",
"null"
],
"description": "A dictionary that maps tag names to specific builds. For details, see [Update build tags](#update-build-tags).",
"additionalProperties": {
"$ref": "#/components/schemas/BuildTag"
},
"example": {
"latest": {
"buildId": "z2EryhbfhgSyqj6Hn"
},
"beta": null
}
},
"actorStandby": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStandby"
},
{
"type": "null"
}
],
"description": "The configuration of the Actor's standby mode. For details, see [Standby mode](https://docs.apify.com/platform/actors/development/programming-interface/standby)."
},
"exampleRunInput": {
"anyOf": [
{
"$ref": "#/components/schemas/ExampleRunInput"
},
{
"type": "null"
}
],
"description": "Sample input payload that demonstrates what a typical run input for an Actor looks like. Used when no explicit input for a run is provided."
},
"isDeprecated": {
"type": [
"boolean",
"null"
],
"description": "Whether the Actor is deprecated."
}
}
},
"ListOfVersions": {
"title": "ListOfVersions",
"type": "object",
"required": [
"total",
"items"
],
"properties": {
"total": {
"type": "integer",
"examples": [
5
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
},
"description": ""
}
}
},
"ListOfVersionsResponse": {
"title": "ListOfVersionsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfVersions"
}
}
},
"VersionResponse": {
"title": "VersionResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Version"
}
}
},
"ListOfEnvVars": {
"title": "ListOfEnvVars",
"type": "object",
"required": [
"total",
"items"
],
"properties": {
"total": {
"type": "integer",
"examples": [
5
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnvVar"
},
"description": ""
}
}
},
"ListOfEnvVarsResponse": {
"title": "ListOfEnvVarsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfEnvVars"
}
}
},
"EnvVarRequest": {
"title": "EnvVarRequest",
"allOf": [
{
"$ref": "#/components/schemas/EnvVar"
},
{
"required": [
"value"
]
}
]
},
"EnvVarResponse": {
"title": "EnvVarResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EnvVar"
}
}
},
"WebhookEventType": {
"title": "WebhookEventType",
"type": "string",
"enum": [
"ACTOR.BUILD.ABORTED",
"ACTOR.BUILD.CREATED",
"ACTOR.BUILD.FAILED",
"ACTOR.BUILD.SUCCEEDED",
"ACTOR.BUILD.TIMED_OUT",
"ACTOR.RUN.ABORTED",
"ACTOR.RUN.CREATED",
"ACTOR.RUN.FAILED",
"ACTOR.RUN.RESURRECTED",
"ACTOR.RUN.SUCCEEDED",
"ACTOR.RUN.TIMED_OUT",
"TEST"
],
"description": "Type of event that triggers the webhook."
},
"WebhookCondition": {
"title": "WebhookCondition",
"type": "object",
"properties": {
"actorId": {
"type": [
"string",
"null"
],
"examples": [
"hksJZtadYvn4mBuin"
]
},
"actorTaskId": {
"type": [
"string",
"null"
],
"examples": [
"asdLZtadYvn4mBZmm"
]
},
"actorRunId": {
"type": [
"string",
"null"
],
"examples": [
"hgdKZtadYvn4mBpoi"
]
}
}
},
"WebhookDispatchStatus": {
"title": "WebhookDispatchStatus",
"type": "string",
"enum": [
"ACTIVE",
"SUCCEEDED",
"FAILED"
],
"description": "Status of the webhook dispatch indicating whether the HTTP request was successful."
},
"ExampleWebhookDispatch": {
"title": "ExampleWebhookDispatch",
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/WebhookDispatchStatus"
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"removedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
null
]
}
}
},
"WebhookStats": {
"title": "WebhookStats",
"type": "object",
"properties": {
"totalDispatches": {
"type": "integer",
"examples": [
1
]
}
}
},
"WebhookShort": {
"title": "WebhookShort",
"required": [
"id",
"createdAt",
"modifiedAt",
"userId",
"eventTypes",
"condition",
"ignoreSslErrors",
"doNotRetry",
"requestUrl"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"YiKoxjkaS9gjGTqhF"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"isAdHoc": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"isApifyIntegration": {
"type": "boolean",
"examples": [
false
]
},
"isEnabled": {
"type": "boolean",
"examples": [
true
]
},
"actionType": {
"type": "string",
"examples": [
"HTTP_REQUEST"
]
},
"shouldInterpolateStrings": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"eventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEventType"
},
"examples": [
[
"ACTOR.RUN.SUCCEEDED"
]
]
},
"condition": {
"$ref": "#/components/schemas/WebhookCondition"
},
"ignoreSslErrors": {
"type": "boolean",
"examples": [
false
]
},
"doNotRetry": {
"type": "boolean",
"examples": [
false
]
},
"requestUrl": {
"type": "string",
"format": "uri",
"examples": [
"http://example.com/"
]
},
"lastDispatch": {
"anyOf": [
{
"$ref": "#/components/schemas/ExampleWebhookDispatch"
},
{
"type": "null"
}
]
},
"stats": {
"anyOf": [
{
"$ref": "#/components/schemas/WebhookStats"
},
{
"type": "null"
}
]
}
}
},
"ListOfWebhooks": {
"title": "ListOfWebhooks",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookShort"
}
}
}
}
]
},
"ListOfWebhooksResponse": {
"title": "ListOfWebhooksResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfWebhooks"
}
}
},
"ActorJobStatus": {
"title": "ActorJobStatus",
"type": "string",
"enum": [
"READY",
"RUNNING",
"SUCCEEDED",
"FAILED",
"TIMING-OUT",
"TIMED-OUT",
"ABORTING",
"ABORTED"
],
"description": "Status of an Actor job (run or build)."
},
"RunOrigin": {
"title": "RunOrigin",
"type": "string",
"enum": [
"DEVELOPMENT",
"WEB",
"API",
"SCHEDULER",
"TEST",
"WEBHOOK",
"ACTOR",
"CLI",
"CI",
"STANDBY",
"MCP"
]
},
"BuildsMeta": {
"title": "BuildsMeta",
"required": [
"origin"
],
"type": "object",
"properties": {
"origin": {
"$ref": "#/components/schemas/RunOrigin"
},
"clientIp": {
"type": [
"string"
],
"description": "IP address of the client that started the build.",
"examples": [
"172.234.12.34"
]
},
"userAgent": {
"type": [
"string"
],
"description": "User agent of the client that started the build.",
"examples": [
"Mozilla/5.0 (iPad)"
]
}
}
},
"BuildShort": {
"title": "BuildShort",
"required": [
"id",
"status",
"startedAt",
"usageTotalUsd",
"buildNumber"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"HG7ML7M8z78YcAPEB"
]
},
"actId": {
"type": "string",
"examples": [
"janedoe~my-actor"
]
},
"userId": {
"type": "string",
"examples": [
"klmdEpoiojmdEMlk3"
]
},
"status": {
"$ref": "#/components/schemas/ActorJobStatus"
},
"startedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-11-30T07:34:24.202Z"
]
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-12T09:30:12.202Z"
]
},
"usageTotalUsd": {
"type": "number",
"examples": [
0.02
]
},
"buildNumber": {
"type": "string",
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$",
"examples": [
"0.1.1"
]
},
"buildNumberInt": {
"type": "integer",
"examples": [
10000
]
},
"meta": {
"$ref": "#/components/schemas/BuildsMeta"
}
}
},
"ListOfBuilds": {
"title": "ListOfBuilds",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildShort"
}
}
}
}
]
},
"ListOfBuildsResponse": {
"title": "ListOfBuildsResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfBuilds"
}
}
},
"BuildStats": {
"title": "BuildStats",
"type": "object",
"properties": {
"durationMillis": {
"type": "integer",
"examples": [
1000
]
},
"runTimeSecs": {
"type": "number",
"examples": [
45.718
]
},
"computeUnits": {
"type": "number",
"examples": [
0.0126994444444444
]
},
"imageSizeBytes": {
"type": [
"integer",
"null"
],
"examples": [
975770223
]
}
}
},
"BuildOptions": {
"title": "BuildOptions",
"type": "object",
"properties": {
"useCache": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"betaPackages": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"memoryMbytes": {
"type": [
"integer",
"null"
],
"examples": [
1024
]
},
"diskMbytes": {
"type": [
"integer",
"null"
],
"examples": [
2048
]
}
}
},
"BuildUsage": {
"title": "BuildUsage",
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": [
"number",
"null"
],
"examples": [
0.08
]
}
}
},
"ActorDefinition": {
"title": "ActorDefinition",
"description": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)",
"type": "object",
"properties": {
"actorSpecification": {
"type": "integer",
"const": 1,
"description": "The Actor specification version that this Actor follows. This property must be set to 1."
},
"name": {
"type": "string",
"description": "The name of the Actor."
},
"version": {
"type": "string",
"pattern": "^[0-9]+(\\.[0-9]+)+$",
"description": "The version of the Actor, typically a dot-separated sequence of numbers (e.g., `0.1`, `1.0`, or `0.0.1`)."
},
"buildTag": {
"type": "string",
"description": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified."
},
"environmentVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of environment variables to be used during local development and deployment."
},
"dockerfile": {
"type": "string",
"description": "The path to the Dockerfile used for building the Actor on the platform."
},
"dockerContextDir": {
"type": "string",
"description": "The path to the directory used as the Docker context when building the Actor."
},
"readme": {
"type": [
"string",
"null"
],
"description": "The path to the README file for the Actor."
},
"input": {
"type": [
"object",
"null"
],
"description": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)"
},
"changelog": {
"type": [
"string",
"null"
],
"description": "The path to the CHANGELOG file displayed in the Actor's information tab."
},
"storages": {
"type": "object",
"properties": {
"dataset": {
"type": "object",
"description": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)"
}
}
},
"defaultMemoryMbytes": {
"oneOf": [
{
"type": "string",
"examples": [
"get(input",
"startUrls.length",
"1) * 1024"
]
},
{
"type": "integer",
"examples": [
1024
]
}
],
"description": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/actors/development/actor-definition/dynamic-actor-memory)."
},
"minMemoryMbytes": {
"type": "integer",
"minimum": 128,
"description": "Specifies the minimum amount of memory in megabytes required by the Actor."
},
"maxMemoryMbytes": {
"type": "integer",
"minimum": 128,
"description": "Specifies the maximum amount of memory in megabytes required by the Actor."
},
"usesStandbyMode": {
"type": "boolean",
"description": "Specifies whether Standby mode is enabled for the Actor."
}
}
},
"Build": {
"title": "Build",
"required": [
"id",
"actId",
"userId",
"startedAt",
"status",
"meta",
"buildNumber"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"HG7ML7M8z78YcAPEB"
]
},
"actId": {
"type": "string",
"examples": [
"janedoe~my-actor"
]
},
"userId": {
"type": "string",
"examples": [
"klmdEpoiojmdEMlk3"
]
},
"startedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-11-30T07:34:24.202Z"
]
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-12T09:30:12.202Z"
]
},
"status": {
"$ref": "#/components/schemas/ActorJobStatus"
},
"meta": {
"$ref": "#/components/schemas/BuildsMeta"
},
"stats": {
"anyOf": [
{
"$ref": "#/components/schemas/BuildStats"
},
{
"type": "null"
}
]
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/BuildOptions"
},
{
"type": "null"
}
]
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/BuildUsage"
},
{
"type": "null"
}
]
},
"usageTotalUsd": {
"type": [
"number",
"null"
],
"examples": [
0.02
],
"description": "Total cost in USD for this build. Requires authentication token to access."
},
"usageUsd": {
"description": "Platform usage costs breakdown in USD for this build. Requires authentication token to access.",
"anyOf": [
{
"$ref": "#/components/schemas/BuildUsage"
},
{
"type": "null"
}
]
},
"inputSchema": {
"type": [
"string",
"null"
],
"deprecated": true,
"examples": [
"{\\n \"title\": \"Schema for ... }"
]
},
"readme": {
"type": [
"string",
"null"
],
"deprecated": true,
"examples": [
"# Magic Actor\\nThis Actor is magic."
]
},
"buildNumber": {
"type": "string",
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$",
"examples": [
"0.1.1"
]
},
"actVersion": {
"title": "BuildActVersion",
"type": "object",
"description": "Snapshot of the Actor version that this build was created from.",
"properties": {
"sourceType": {
"$ref": "#/components/schemas/VersionSourceType"
},
"buildTag": {
"type": "string",
"examples": [
"experimental"
]
},
"versionNumber": {
"type": "string",
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$",
"examples": [
"0.0"
]
},
"gitRepoUrl": {
"type": "string",
"description": "URL of the git repository, present when sourceType is GIT_REPO.",
"examples": [
"https://github.com/apifytech/actor-crawler.git#experimental:web-scraper"
]
},
"sourceFiles": {
"type": "array",
"description": "Inline source files, present when sourceType is SOURCE_FILES.",
"items": {
"$ref": "#/components/schemas/SourceCodeFile"
}
}
}
},
"actorDefinition": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorDefinition"
},
{
"type": "null"
}
]
}
},
"example": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "janedoe~my-actor",
"userId": "klmdEpoiojmdEMlk3",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"status": "SUCCEEDED",
"meta": {
"origin": "WEB",
"clientIp": "172.234.12.34",
"userAgent": "Mozilla/5.0 (iPad)"
},
"stats": {
"durationMillis": 1000,
"runTimeSecs": 45.718,
"computeUnits": 0.012699444444444444
},
"options": {
"useCache": false,
"betaPackages": false,
"memoryMbytes": 1024,
"diskMbytes": 2048
},
"usage": {
"ACTOR_COMPUTE_UNITS": 0.08
},
"usageTotalUsd": 0.02,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.02
},
"inputSchema": "{\\n \"title\": \"Schema for ...\"}",
"readme": "# Magic Actor\\nThis Actor is magic.",
"buildNumber": "0.1.1",
"actorDefinition": {
"actorSpecification": 1,
"name": "example-actor",
"version": "1.0",
"buildTag": "latest",
"environmentVariables": {
"DEBUG_MODE": "false"
},
"input": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "The text prompt to generate completions for."
},
"maxTokens": {
"type": "integer",
"description": "The maximum number of tokens to generate."
}
},
"required": [
"prompt"
]
},
"storages": {
"dataset": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the generated text."
},
"text": {
"type": "string",
"description": "The generated text output from the model."
}
},
"required": [
"id",
"text"
]
}
},
"minMemoryMbytes": 512,
"maxMemoryMbytes": 2048,
"usesStandbyMode": false
}
}
},
"BuildResponse": {
"title": "BuildResponse",
"description": "Response containing Actor build data.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Build"
}
}
},
"RunMeta": {
"title": "RunMeta",
"required": [
"origin"
],
"type": "object",
"properties": {
"origin": {
"$ref": "#/components/schemas/RunOrigin"
},
"clientIp": {
"type": [
"string",
"null"
],
"description": "IP address of the client that started the run."
},
"userAgent": {
"type": [
"string",
"null"
],
"description": "User agent of the client that started the run."
},
"scheduleId": {
"type": [
"string",
"null"
],
"description": "ID of the schedule that triggered the run."
},
"scheduledAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Time when the run was scheduled."
}
}
},
"RunShort": {
"title": "RunShort",
"required": [
"id",
"actId",
"status",
"startedAt",
"buildId",
"meta",
"usageTotalUsd",
"defaultKeyValueStoreId",
"defaultDatasetId",
"defaultRequestQueueId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"HG7ML7M8z78YcAPEB"
]
},
"actId": {
"type": "string",
"examples": [
"HDSasDasz78YcAPEB"
]
},
"userId": {
"type": "string",
"examples": [
"7sT5jcggjjA9fNcxF"
]
},
"actorTaskId": {
"type": [
"string",
"null"
],
"examples": [
"KJHSKHausidyaJKHs"
]
},
"status": {
"$ref": "#/components/schemas/ActorJobStatus"
},
"startedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-11-30T07:34:24.202Z"
]
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-12T09:30:12.202Z"
]
},
"buildId": {
"type": "string",
"examples": [
"HG7ML7M8z78YcAPEB"
]
},
"buildNumber": {
"type": "string",
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$",
"examples": [
"0.0.2"
]
},
"buildNumberInt": {
"type": "integer",
"examples": [
10000
]
},
"meta": {
"$ref": "#/components/schemas/RunMeta"
},
"usageTotalUsd": {
"type": "number",
"examples": [
0.2
]
},
"defaultKeyValueStoreId": {
"type": "string",
"examples": [
"sfAjeR4QmeJCQzTfe"
]
},
"defaultDatasetId": {
"type": "string",
"examples": [
"3ZojQDdFTsyE7Moy4"
]
},
"defaultRequestQueueId": {
"type": "string",
"examples": [
"so93g2shcDzK3pA85"
]
}
}
},
"ListOfRuns": {
"title": "ListOfRuns",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RunShort"
}
}
}
}
]
},
"ListOfRunsResponse": {
"title": "ListOfRunsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfRuns"
}
}
},
"WebhookRepresentation": {
"title": "WebhookRepresentation",
"description": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here.\n",
"required": [
"eventTypes",
"requestUrl"
],
"type": "object",
"properties": {
"eventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEventType"
},
"examples": [
[
"ACTOR.RUN.SUCCEEDED"
]
]
},
"requestUrl": {
"type": "string",
"description": "The URL to which the webhook sends its payload.",
"examples": [
"http://example.com/"
]
},
"payloadTemplate": {
"type": [
"string",
"null"
],
"description": "Optional template for the JSON payload sent by the webhook.",
"examples": [
"{\\n \"userId\": {{userId}}..."
]
},
"headersTemplate": {
"type": [
"string",
"null"
],
"description": "Optional template for the HTTP headers sent by the webhook.",
"examples": [
"{\\n \"Authorization\": \"Bearer ...\"}"
]
},
"shouldInterpolateStrings": {
"type": [
"boolean",
"null"
],
"description": "Flag to also interpolate `{{...}}` variables inside string values of the payload and headers templates.",
"examples": [
false
]
},
"idempotencyKey": {
"type": [
"string",
"null"
],
"description": "Key that prevents creating duplicate webhooks, e.g. when the run-starting request is retried.",
"examples": [
"fdSJmdP3nfs7sfk3y"
]
},
"ignoreSslErrors": {
"type": [
"boolean",
"null"
],
"description": "Flag to ignore SSL errors when the webhook sends the request.",
"examples": [
false
]
},
"doNotRetry": {
"type": [
"boolean",
"null"
],
"description": "Flag to skip retrying the webhook request on failure.",
"examples": [
false
]
}
}
},
"RunStats": {
"title": "RunStats",
"type": "object",
"properties": {
"inputBodyLen": {
"type": [
"integer",
"null"
],
"minimum": 0,
"examples": [
240
]
},
"migrationCount": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"rebootCount": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"restartCount": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"resurrectCount": {
"type": "integer",
"minimum": 0,
"examples": [
2
]
},
"memAvgBytes": {
"type": "number",
"examples": [
267874071.9
]
},
"memMaxBytes": {
"type": "integer",
"minimum": 0,
"examples": [
404713472
]
},
"memCurrentBytes": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"cpuAvgUsage": {
"type": "number",
"examples": [
33.7532101107538
]
},
"cpuMaxUsage": {
"type": "number",
"examples": [
169.650735534941
]
},
"cpuCurrentUsage": {
"type": "number",
"examples": [
0
]
},
"netRxBytes": {
"type": "integer",
"minimum": 0,
"examples": [
103508042
]
},
"netTxBytes": {
"type": "integer",
"minimum": 0,
"examples": [
4854600
]
},
"durationMillis": {
"type": "integer",
"minimum": 0,
"examples": [
248472
]
},
"runTimeSecs": {
"type": "number",
"minimum": 0,
"examples": [
248.472
]
},
"metamorph": {
"type": "integer",
"minimum": 0,
"examples": [
0
]
},
"computeUnits": {
"type": "number",
"minimum": 0,
"examples": [
0.13804
]
}
}
},
"RunOptions": {
"title": "RunOptions",
"required": [
"build",
"timeoutSecs",
"memoryMbytes",
"diskMbytes"
],
"type": "object",
"properties": {
"build": {
"type": "string",
"examples": [
"latest"
]
},
"timeoutSecs": {
"type": "integer",
"minimum": 0,
"examples": [
300
]
},
"memoryMbytes": {
"type": "integer",
"minimum": 128,
"maximum": 32768,
"examples": [
1024
]
},
"diskMbytes": {
"type": "integer",
"minimum": 0,
"examples": [
2048
]
},
"maxItems": {
"type": [
"integer",
"null"
],
"minimum": 0,
"examples": [
1000
]
},
"maxTotalChargeUsd": {
"type": [
"number",
"null"
],
"minimum": 0,
"examples": [
5
]
}
}
},
"GeneralAccess": {
"title": "GeneralAccess",
"type": "string",
"enum": [
"ANYONE_WITH_ID_CAN_READ",
"ANYONE_WITH_NAME_CAN_READ",
"FOLLOW_USER_SETTING",
"RESTRICTED"
],
"examples": [
"RESTRICTED"
],
"description": "Defines the general access level for the resource."
},
"RunUsage": {
"title": "RunUsage",
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": [
"number",
"null"
],
"examples": [
3
]
},
"DATASET_READS": {
"type": [
"integer",
"null"
],
"examples": [
4
]
},
"DATASET_WRITES": {
"type": [
"integer",
"null"
],
"examples": [
4
]
},
"KEY_VALUE_STORE_READS": {
"type": [
"integer",
"null"
],
"examples": [
5
]
},
"KEY_VALUE_STORE_WRITES": {
"type": [
"integer",
"null"
],
"examples": [
3
]
},
"KEY_VALUE_STORE_LISTS": {
"type": [
"integer",
"null"
],
"examples": [
5
]
},
"REQUEST_QUEUE_READS": {
"type": [
"integer",
"null"
],
"examples": [
2
]
},
"REQUEST_QUEUE_WRITES": {
"type": [
"integer",
"null"
],
"examples": [
1
]
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": [
"number",
"null"
],
"examples": [
1
]
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": [
"number",
"null"
],
"examples": [
3
]
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": [
"number",
"null"
],
"examples": [
34
]
},
"PROXY_SERPS": {
"type": [
"integer",
"null"
],
"examples": [
3
]
}
}
},
"RunUsageUsd": {
"title": "RunUsageUsd",
"description": "Resource usage costs in USD. All values are monetary amounts in US dollars.",
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": [
"number",
"null"
],
"examples": [
0.0003
]
},
"DATASET_READS": {
"type": [
"number",
"null"
],
"examples": [
0.0001
]
},
"DATASET_WRITES": {
"type": [
"number",
"null"
],
"examples": [
0.0001
]
},
"KEY_VALUE_STORE_READS": {
"type": [
"number",
"null"
],
"examples": [
0.0001
]
},
"KEY_VALUE_STORE_WRITES": {
"type": [
"number",
"null"
],
"examples": [
0.00005
]
},
"KEY_VALUE_STORE_LISTS": {
"type": [
"number",
"null"
],
"examples": [
0.0001
]
},
"REQUEST_QUEUE_READS": {
"type": [
"number",
"null"
],
"examples": [
0.0001
]
},
"REQUEST_QUEUE_WRITES": {
"type": [
"number",
"null"
],
"examples": [
0.0001
]
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": [
"number",
"null"
],
"examples": [
0.001
]
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": [
"number",
"null"
],
"examples": [
0.003
]
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": [
"number",
"null"
],
"examples": [
0.034
]
},
"PROXY_SERPS": {
"type": [
"number",
"null"
],
"examples": [
0.003
]
}
}
},
"Metamorph": {
"title": "Metamorph",
"description": "Information about a metamorph event that occurred during the run.",
"type": "object",
"required": [
"createdAt",
"actorId",
"buildId"
],
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Time when the metamorph occurred.",
"examples": [
"2019-11-30T07:39:24.202Z"
]
},
"actorId": {
"type": "string",
"description": "ID of the Actor that the run was metamorphed to.",
"examples": [
"nspoEjklmnsF2oosD"
]
},
"buildId": {
"type": "string",
"description": "ID of the build used for the metamorphed Actor.",
"examples": [
"ME6oKecqy5kXDS4KQ"
]
},
"inputKey": {
"type": [
"string",
"null"
],
"description": "Key of the input record in the key-value store.",
"examples": [
"INPUT-METAMORPH-1"
]
}
}
},
"Run": {
"title": "Run",
"description": "Represents an Actor run and its associated data.",
"required": [
"id",
"actId",
"userId",
"startedAt",
"status",
"meta",
"stats",
"options",
"buildId",
"defaultKeyValueStoreId",
"defaultDatasetId",
"defaultRequestQueueId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"HG7ML7M8z78YcAPEB"
],
"description": "Unique identifier of the Actor run."
},
"actId": {
"type": "string",
"examples": [
"HDSasDasz78YcAPEB"
],
"description": "ID of the Actor that was run."
},
"userId": {
"type": "string",
"examples": [
"7sT5jcggjjA9fNcxF"
],
"description": "ID of the user who started the run."
},
"actorTaskId": {
"type": [
"string",
"null"
],
"examples": [
"KJHSKHausidyaJKHs"
],
"description": "ID of the Actor task, if the run was started from a task."
},
"startedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-11-30T07:34:24.202Z"
],
"description": "Time when the Actor run started."
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-12T09:30:12.202Z"
],
"description": "Time when the Actor run finished."
},
"status": {
"description": "Current status of the Actor run.",
"$ref": "#/components/schemas/ActorJobStatus"
},
"statusMessage": {
"type": [
"string",
"null"
],
"examples": [
"Actor is running"
],
"description": "Detailed message about the run status."
},
"isStatusMessageTerminal": {
"type": [
"boolean",
"null"
],
"examples": [
false
],
"description": "Whether the status message is terminal (final)."
},
"meta": {
"description": "Metadata about the Actor run.",
"$ref": "#/components/schemas/RunMeta"
},
"pricingInfo": {
"description": "Pricing information for the Actor.",
"$ref": "#/components/schemas/ActorRunPricingInfo"
},
"stats": {
"description": "Statistics of the Actor run.",
"$ref": "#/components/schemas/RunStats"
},
"chargedEventCounts": {
"description": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run.",
"type": "object",
"additionalProperties": {
"type": "integer"
},
"example": {
"actor-start": 1,
"page-crawled": 150,
"data-extracted": 75
}
},
"options": {
"description": "Configuration options for the Actor run.",
"$ref": "#/components/schemas/RunOptions"
},
"buildId": {
"type": "string",
"examples": [
"7sT5jcggjjA9fNcxF"
],
"description": "ID of the Actor build used for this run."
},
"exitCode": {
"type": [
"integer",
"null"
],
"examples": [
0
],
"description": "Exit code of the Actor run process."
},
"generalAccess": {
"description": "General access level for the Actor run.",
"anyOf": [
{
"$ref": "#/components/schemas/GeneralAccess"
},
{
"type": "null"
}
]
},
"defaultKeyValueStoreId": {
"type": "string",
"examples": [
"eJNzqsbPiopwJcgGQ"
],
"description": "ID of the default key-value store for this run."
},
"defaultDatasetId": {
"type": "string",
"examples": [
"wmKPijuyDnPZAPRMk"
],
"description": "ID of the default dataset for this run."
},
"defaultRequestQueueId": {
"type": "string",
"examples": [
"FL35cSF7jrxr3BY39"
],
"description": "ID of the default request queue for this run."
},
"storageIds": {
"type": "object",
"description": "A map of aliased storage IDs associated with this run, grouped by storage type.",
"properties": {
"datasets": {
"type": "object",
"description": "Aliased dataset IDs for this run.",
"properties": {
"default": {
"type": "string",
"description": "ID of the default dataset for this run.",
"example": "wmKPijuyDnPZAPRMk"
}
},
"additionalProperties": {
"type": "string"
}
},
"keyValueStores": {
"type": "object",
"description": "Aliased key-value store IDs for this run.",
"properties": {
"default": {
"type": "string",
"description": "ID of the default key-value store for this run.",
"example": "eJNzqsbPiopwJcgGQ"
}
},
"additionalProperties": {
"type": "string"
}
},
"requestQueues": {
"type": "object",
"description": "Aliased request queue IDs for this run.",
"properties": {
"default": {
"type": "string",
"description": "ID of the default request queue for this run.",
"example": "FL35cSF7jrxr3BY39"
}
},
"additionalProperties": {
"type": "string"
}
}
}
},
"buildNumber": {
"type": [
"string",
"null"
],
"pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$",
"examples": [
"0.0.36"
],
"description": "Build number of the Actor build used for this run."
},
"containerUrl": {
"type": "string",
"format": "uri",
"examples": [
"https://g8kd8kbc5ge8.runs.apify.net"
],
"description": "URL of the container running the Actor."
},
"isContainerServerReady": {
"type": [
"boolean",
"null"
],
"examples": [
true
],
"description": "Whether the container's HTTP server is ready to accept requests."
},
"gitBranchName": {
"type": [
"string",
"null"
],
"examples": [
"master"
],
"description": "Name of the git branch used for the Actor build."
},
"usage": {
"description": "Resource usage statistics for the run.",
"anyOf": [
{
"$ref": "#/components/schemas/RunUsage"
},
{
"type": "null"
}
]
},
"usageTotalUsd": {
"type": [
"number",
"null"
],
"examples": [
0.2654
],
"description": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access."
},
"usageUsd": {
"description": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access.",
"anyOf": [
{
"$ref": "#/components/schemas/RunUsageUsd"
},
{
"type": "null"
}
]
},
"metamorphs": {
"description": "List of metamorph events that occurred during the run.",
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Metamorph"
}
},
{
"type": "null"
}
]
},
"platformUsageBillingModel": {
"type": "string",
"description": "Indicates which party covers platform usage costs for this run.",
"examples": [
"USER"
]
}
}
},
"RunResponse": {
"title": "RunResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Run"
}
}
},
"DatasetStats": {
"title": "DatasetStats",
"type": "object",
"properties": {
"readCount": {
"type": "integer",
"examples": [
22
]
},
"writeCount": {
"type": "integer",
"examples": [
3
]
},
"storageBytes": {
"type": "integer",
"description": "Total storage size in bytes. Only returned by the single-dataset endpoint.",
"examples": [
783
]
},
"inflatedBytes": {
"type": "integer",
"description": "Uncompressed size in bytes. Only returned by the dataset list endpoint.",
"examples": [
0
]
}
}
},
"Dataset": {
"title": "Dataset",
"required": [
"id",
"userId",
"createdAt",
"modifiedAt",
"accessedAt",
"itemCount",
"cleanItemCount",
"consoleUrl"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"WkzbQMuFYuamGv3YF"
]
},
"name": {
"type": [
"string",
"null"
],
"examples": [
"d7b9MDYsbtX5L7XAj"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"accessedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-14T08:36:13.202Z"
]
},
"itemCount": {
"type": "integer",
"minimum": 0,
"examples": [
7
]
},
"cleanItemCount": {
"type": "integer",
"minimum": 0,
"examples": [
5
]
},
"actId": {
"type": [
"string",
"null"
]
},
"actRunId": {
"type": [
"string",
"null"
]
},
"fields": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": ""
},
"schema": {
"type": [
"object",
"null"
],
"description": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/storage/dataset-schema)",
"example": {
"actorSpecification": 1,
"title": "My dataset",
"views": {
"overview": {
"title": "Overview",
"transformation": {
"fields": [
"linkUrl"
]
},
"display": {
"component": "table",
"properties": {
"linkUrl": {
"label": "Link URL",
"format": "link"
}
}
}
}
}
}
},
"consoleUrl": {
"type": "string",
"format": "uri",
"examples": [
"https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC"
]
},
"itemsPublicUrl": {
"type": "string",
"format": "uri",
"description": "A public link to access the dataset items directly.",
"examples": [
"https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123"
]
},
"urlSigningSecretKey": {
"type": [
"string",
"null"
],
"description": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset."
},
"generalAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/GeneralAccess"
},
{
"type": "null"
}
]
},
"stats": {
"$ref": "#/components/schemas/DatasetStats"
}
}
},
"DatasetResponse": {
"title": "DatasetResponse",
"description": "Response containing dataset metadata.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Dataset"
}
}
},
"UpdateDatasetRequest": {
"title": "UpdateDatasetRequest",
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"generalAccess": {
"$ref": "#/components/schemas/GeneralAccess"
}
},
"example": {
"name": "new-dataset-name",
"generalAccess": "RESTRICTED"
}
},
"PutItemsRequest": {
"title": "PutItemsRequest",
"description": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item.\n",
"type": "object",
"additionalProperties": true,
"example": {
"title": "Example Item",
"url": "https://example.com",
"price": 19.99
}
},
"ValidationError": {
"title": "ValidationError",
"type": "object",
"properties": {
"instancePath": {
"type": "string",
"description": "The path to the instance being validated."
},
"schemaPath": {
"type": "string",
"description": "The path to the schema that failed the validation."
},
"keyword": {
"type": "string",
"description": "The validation keyword that caused the error."
},
"message": {
"type": "string",
"description": "A message describing the validation error."
},
"params": {
"type": "object",
"description": "Additional parameters specific to the validation error."
}
}
},
"InvalidItem": {
"title": "InvalidItem",
"type": "object",
"properties": {
"itemPosition": {
"type": "integer",
"description": "The position of the invalid item in the array.",
"examples": [
2
]
},
"validationErrors": {
"type": "array",
"description": "A complete list of AJV validation error objects for the invalid item.",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
},
"SchemaValidationErrorData": {
"title": "SchemaValidationErrorData",
"required": [
"invalidItems"
],
"type": "object",
"properties": {
"invalidItems": {
"type": "array",
"description": "A list of invalid items in the received array of items.",
"items": {
"$ref": "#/components/schemas/InvalidItem"
}
}
}
},
"DatasetSchemaValidationError": {
"title": "DatasetSchemaValidationError",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the error.",
"examples": [
"schema-validation-error"
]
},
"message": {
"type": "string",
"description": "A human-readable message describing the error.",
"examples": [
"Schema validation failed"
]
},
"data": {
"$ref": "#/components/schemas/SchemaValidationErrorData"
}
}
},
"PutItemResponseError": {
"title": "PutItemResponseError",
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/DatasetSchemaValidationError"
}
},
"example": {
"error": {
"type": "schema-validation-error",
"message": "Schema validation failed",
"data": {
"invalidItems": [
{
"itemPosition": 2,
"validationErrors": [
{
"instancePath": "/1/stringField",
"schemaPath": "/items/properties/stringField/type",
"keyword": "type",
"params": {
"type": "string"
},
"message": "must be string"
}
]
}
]
}
}
}
},
"DatasetFieldStatistics": {
"title": "DatasetFieldStatistics",
"type": "object",
"properties": {
"min": {
"type": [
"number",
"null"
],
"description": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object."
},
"max": {
"type": [
"number",
"null"
],
"description": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object."
},
"nullCount": {
"type": [
"integer",
"null"
],
"description": "How many items in the dataset have a null value for this field."
},
"emptyCount": {
"type": [
"integer",
"null"
],
"description": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty."
}
}
},
"DatasetStatistics": {
"title": "DatasetStatistics",
"type": "object",
"properties": {
"fieldStatistics": {
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/components/schemas/DatasetFieldStatistics"
},
"description": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema. <br>See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information."
}
},
"example": {
"fieldStatistics": {
"name": {
"nullCount": 122
},
"price": {
"min": 59,
"max": 89
}
}
}
},
"DatasetStatisticsResponse": {
"title": "DatasetStatisticsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DatasetStatistics"
}
}
},
"KeyValueStoreStats": {
"title": "KeyValueStoreStats",
"type": "object",
"properties": {
"readCount": {
"type": "integer",
"examples": [
9
]
},
"writeCount": {
"type": "integer",
"examples": [
3
]
},
"deleteCount": {
"type": "integer",
"examples": [
6
]
},
"listCount": {
"type": "integer",
"examples": [
2
]
},
"s3StorageBytes": {
"type": "integer",
"examples": [
18
]
},
"storageBytes": {
"type": "integer",
"examples": [
457225
]
}
}
},
"KeyValueStore": {
"title": "KeyValueStore",
"required": [
"id",
"createdAt",
"modifiedAt",
"accessedAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"WkzbQMuFYuamGv3YF"
]
},
"name": {
"type": [
"string",
"null"
],
"examples": [
"d7b9MDYsbtX5L7XAj"
]
},
"userId": {
"type": [
"string",
"null"
],
"examples": [
"BPWDBd7Z9c746JAnF"
]
},
"username": {
"type": [
"string",
"null"
],
"examples": [
"janedoe"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"accessedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-14T08:36:13.202Z"
]
},
"actId": {
"type": [
"string",
"null"
],
"examples": [
null
]
},
"actRunId": {
"type": [
"string",
"null"
],
"examples": [
null
]
},
"consoleUrl": {
"type": "string",
"format": "uri",
"examples": [
"https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC"
]
},
"keysPublicUrl": {
"type": "string",
"format": "uri",
"description": "A public link to access keys of the key-value store directly.",
"examples": [
"https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123"
]
},
"recordsPublicUrl": {
"type": "string",
"format": "uri",
"description": "A public link to access records of the key-value store directly.",
"examples": [
"https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records"
]
},
"schema": {
"type": [
"object",
"null"
],
"description": "Optional JSON schema describing the keys stored in the key-value store."
},
"urlSigningSecretKey": {
"type": [
"string",
"null"
],
"description": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store."
},
"generalAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/GeneralAccess"
},
{
"type": "null"
}
]
},
"stats": {
"$ref": "#/components/schemas/KeyValueStoreStats"
}
}
},
"KeyValueStoreResponse": {
"title": "KeyValueStoreResponse",
"description": "Response containing key-value store data.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/KeyValueStore"
}
}
},
"UpdateStoreRequest": {
"title": "UpdateStoreRequest",
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"generalAccess": {
"$ref": "#/components/schemas/GeneralAccess"
}
},
"example": {
"name": "new-store-name",
"generalAccess": "RESTRICTED"
}
},
"KeyValueStoreKey": {
"title": "KeyValueStoreKey",
"type": "object",
"required": [
"key",
"size",
"recordPublicUrl"
],
"properties": {
"key": {
"type": "string",
"examples": [
"second-key"
]
},
"size": {
"type": "integer",
"examples": [
36
]
},
"recordPublicUrl": {
"type": "string",
"format": "uri",
"description": "A public link to access this record directly.",
"examples": [
"https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123"
]
}
}
},
"ListOfKeys": {
"title": "ListOfKeys",
"type": "object",
"required": [
"items",
"count",
"limit",
"isTruncated"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyValueStoreKey"
},
"description": ""
},
"count": {
"type": "integer",
"examples": [
2
]
},
"limit": {
"type": "integer",
"examples": [
2
]
},
"exclusiveStartKey": {
"type": [
"string",
"null"
],
"examples": [
"some-key"
]
},
"isTruncated": {
"type": "boolean",
"examples": [
true
]
},
"nextExclusiveStartKey": {
"type": [
"string",
"null"
],
"examples": [
"third-key"
]
}
}
},
"ListOfKeysResponse": {
"title": "ListOfKeysResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfKeys"
}
},
"example": {
"data": {
"items": [
{
"key": "second-key",
"size": 36,
"recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/second-key?signature=abc123"
},
{
"key": "third-key",
"size": 128,
"recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/third-key?signature=abc123"
}
],
"count": 2,
"limit": 2,
"exclusiveStartKey": "some-key",
"isTruncated": true,
"nextExclusiveStartKey": "third-key"
}
}
},
"RecordResponse": {
"title": "RecordResponse",
"description": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record.\n",
"type": "object",
"additionalProperties": true,
"example": {
"message": "Hello, world!",
"count": 42
}
},
"PutRecordRequest": {
"title": "PutRecordRequest",
"description": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header.\n",
"type": "object",
"additionalProperties": true,
"example": {
"message": "Hello, world!",
"count": 42
}
},
"QueueId": {
"type": "string",
"description": "A unique identifier assigned to the request queue.",
"examples": [
"WkzbQMuFYuamGv3YF"
]
},
"QueueUserId": {
"type": "string",
"description": "The ID of the user who owns the request queue.",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"QueueCreatedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the request queue was created.",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"QueueModifiedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue.",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"QueueAccessedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the request queue was last accessed.",
"examples": [
"2019-12-14T08:36:13.202Z"
]
},
"TotalRequestCount": {
"type": "integer",
"description": "The total number of requests in the request queue.",
"minimum": 0,
"examples": [
870
]
},
"HandledRequestCount": {
"type": "integer",
"description": "The number of requests that have been handled.",
"minimum": 0,
"examples": [
100
]
},
"PendingRequestCount": {
"type": "integer",
"description": "The number of requests that are pending and have not been handled yet.",
"examples": [
670
]
},
"HadMultipleClients": {
"type": "boolean",
"description": "Whether the request queue has been accessed by multiple different clients.",
"examples": [
true
]
},
"RequestQueueStats": {
"title": "RequestQueueStats",
"description": "Statistics about request queue operations and storage.",
"type": "object",
"properties": {
"deleteCount": {
"type": "integer",
"description": "The number of delete operations performed on the request queue.",
"examples": [
0
]
},
"headItemReadCount": {
"type": "integer",
"description": "The number of times requests from the head were read.",
"examples": [
5
]
},
"readCount": {
"type": "integer",
"description": "The total number of read operations performed on the request queue.",
"examples": [
100
]
},
"storageBytes": {
"type": "integer",
"description": "The total storage size in bytes used by the request queue.",
"examples": [
1024
]
},
"writeCount": {
"type": "integer",
"description": "The total number of write operations performed on the request queue.",
"examples": [
10
]
}
}
},
"RequestQueue": {
"title": "RequestQueue",
"description": "A request queue object containing metadata and statistics.",
"required": [
"id",
"userId",
"createdAt",
"modifiedAt",
"accessedAt",
"totalRequestCount",
"handledRequestCount",
"pendingRequestCount",
"hadMultipleClients",
"consoleUrl"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/QueueId"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the request queue.",
"examples": [
"some-name"
]
},
"userId": {
"$ref": "#/components/schemas/QueueUserId"
},
"actId": {
"type": [
"string",
"null"
],
"description": "The ID of the Actor that created this request queue."
},
"actRunId": {
"type": [
"string",
"null"
],
"description": "The ID of the Actor run that created this request queue."
},
"createdAt": {
"$ref": "#/components/schemas/QueueCreatedAt"
},
"modifiedAt": {
"$ref": "#/components/schemas/QueueModifiedAt"
},
"accessedAt": {
"$ref": "#/components/schemas/QueueAccessedAt"
},
"totalRequestCount": {
"$ref": "#/components/schemas/TotalRequestCount"
},
"handledRequestCount": {
"$ref": "#/components/schemas/HandledRequestCount"
},
"pendingRequestCount": {
"$ref": "#/components/schemas/PendingRequestCount"
},
"hadMultipleClients": {
"$ref": "#/components/schemas/HadMultipleClients"
},
"consoleUrl": {
"type": "string",
"description": "The URL to view the request queue in the Apify console.",
"format": "uri",
"examples": [
"https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC"
]
},
"stats": {
"$ref": "#/components/schemas/RequestQueueStats"
},
"generalAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/GeneralAccess"
},
{
"type": "null"
}
]
}
}
},
"RequestQueueResponse": {
"title": "RequestQueueResponse",
"description": "Response containing request queue data.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RequestQueue"
}
}
},
"UpdateRequestQueueRequest": {
"title": "UpdateRequestQueueRequest",
"description": "Request object for updating a request queue.",
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "The new name for the request queue."
},
"generalAccess": {
"$ref": "#/components/schemas/GeneralAccess"
}
},
"example": {
"name": "new-request-queue-name",
"generalAccess": "RESTRICTED"
}
},
"UniqueKey": {
"type": "string",
"description": "A unique key used for request de-duplication. Requests with the same unique key are considered identical.",
"examples": [
"GET|60d83e70|e3b0c442|https://apify.com"
]
},
"RequestUrl": {
"type": "string",
"description": "The URL of the request.",
"examples": [
"https://apify.com"
]
},
"HttpMethod": {
"type": "string",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
"PATCH"
],
"examples": [
"GET"
]
},
"RequestMethod": {
"description": "The HTTP method of the request.",
"$ref": "#/components/schemas/HttpMethod"
},
"RetryCount": {
"type": "integer",
"description": "The number of times this request has been retried.",
"examples": [
0
]
},
"RequestUserData": {
"title": "RequestUserData",
"description": "Custom user data attached to the request. Can contain arbitrary fields.",
"type": "object",
"additionalProperties": true,
"example": {
"label": "DETAIL",
"customField": "custom-value"
}
},
"RequestBase": {
"title": "RequestBase",
"type": "object",
"required": [
"uniqueKey",
"url"
],
"properties": {
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"url": {
"$ref": "#/components/schemas/RequestUrl"
},
"method": {
"$ref": "#/components/schemas/RequestMethod"
},
"retryCount": {
"$ref": "#/components/schemas/RetryCount"
},
"loadedUrl": {
"type": [
"string",
"null"
],
"description": "The final URL that was loaded, after redirects (if any).",
"examples": [
"https://apify.com/jobs"
]
},
"payload": {
"type": [
"string",
"object",
"null"
],
"description": "The request payload, typically used with POST or PUT requests.",
"examples": [
null
]
},
"headers": {
"type": [
"object",
"null"
],
"description": "HTTP headers sent with the request.",
"examples": [
null
]
},
"userData": {
"$ref": "#/components/schemas/RequestUserData"
},
"noRetry": {
"type": [
"boolean",
"null"
],
"description": "Indicates whether the request should not be retried if processing fails.",
"examples": [
false
]
},
"errorMessages": {
"type": [
"array",
"null"
],
"description": "Error messages recorded from failed processing attempts.",
"items": {
"type": "string"
},
"examples": [
null
]
},
"handledAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The timestamp when the request was marked as handled, if applicable.",
"examples": [
"2019-06-16T10:23:31.607Z"
]
}
}
},
"RequestId": {
"type": "string",
"description": "A unique identifier assigned to the request.",
"examples": [
"sbJ7klsdf7ujN9l"
]
},
"Request": {
"title": "Request",
"description": "A request stored in the request queue, including its metadata and processing state.",
"allOf": [
{
"$ref": "#/components/schemas/RequestBase",
"required": [
"id"
]
},
{
"properties": {
"id": {
"$ref": "#/components/schemas/RequestId"
}
}
}
]
},
"ListOfRequests": {
"title": "ListOfRequests",
"description": "A paginated list of requests from the request queue.",
"type": "object",
"required": [
"items",
"limit"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Request"
},
"description": "The array of requests."
},
"limit": {
"type": "integer",
"description": "The maximum number of requests returned in this response.",
"examples": [
2
]
},
"exclusiveStartId": {
"deprecated": true,
"type": "string",
"description": "The ID of the last request from the previous page, used for pagination.",
"examples": [
"Ihnsp8YrvJ8102Kj"
]
},
"cursor": {
"type": "string",
"description": "A cursor string used for current page of results.",
"examples": [
"eyJyZXF1ZXN0SWQiOiI0SVlLUWFXZ2FKUUlWNlMifQ"
]
},
"nextCursor": {
"type": "string",
"description": "A cursor string to be used to continue pagination.",
"examples": [
"eyJyZXF1ZXN0SWQiOiI5eFNNc1BrN1J6VUxTNXoifQ"
]
}
}
},
"ListOfRequestsResponse": {
"title": "ListOfRequestsResponse",
"description": "Response containing a list of requests from the request queue.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfRequests"
}
},
"example": {
"data": {
"items": [
{
"id": "dnjkDMKLmdlkmlkmld",
"retryCount": 0,
"uniqueKey": "http://example.com",
"url": "http://example.com",
"method": "GET",
"loadedUrl": "http://example.com/example-1",
"payload": null,
"noRetry": false,
"errorMessages": null,
"headers": null,
"userData": {
"label": "DETAIL",
"image": "https://picserver1.eu"
},
"handledAt": "2019-06-16T10:23:31.607Z"
},
{
"id": "dnjkDMKLmdlkmlkmld",
"retryCount": 0,
"uniqueKey": "http://example.com",
"url": "http://example.com",
"method": "GET",
"loadedUrl": "http://example.com/example-1",
"payload": null,
"noRetry": false,
"errorMessages": null,
"headers": null,
"userData": {
"label": "DETAIL",
"image": "https://picserver1.eu"
},
"handledAt": "2019-06-16T10:23:31.607Z"
}
],
"limit": 2,
"exclusiveStartId": "Ihnsp8YrvJ8102Kj"
}
}
},
"RequestWithoutId": {
"title": "RequestWithoutId",
"description": "A request stored in the request queue, including its metadata and processing state, without the assigned ID.",
"allOf": [
{
"$ref": "#/components/schemas/RequestBase"
}
]
},
"WasAlreadyPresent": {
"type": "boolean",
"description": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created.",
"examples": [
false
]
},
"WasAlreadyHandled": {
"type": "boolean",
"description": "Indicates whether a request with the same unique key has already been processed by the request queue.",
"examples": [
false
]
},
"RequestRegistration": {
"title": "RequestRegistration",
"description": "Result of registering a request in the request queue, either by adding a new request or updating an existing one.",
"required": [
"requestId",
"wasAlreadyPresent",
"wasAlreadyHandled"
],
"type": "object",
"properties": {
"requestId": {
"$ref": "#/components/schemas/RequestId"
},
"wasAlreadyPresent": {
"$ref": "#/components/schemas/WasAlreadyPresent"
},
"wasAlreadyHandled": {
"$ref": "#/components/schemas/WasAlreadyHandled"
}
}
},
"AddRequestResponse": {
"title": "AddRequestResponse",
"description": "Response containing the result of adding a request to the request queue.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RequestRegistration"
}
}
},
"AddedRequest": {
"title": "AddedRequest",
"description": "Information about a request that was successfully added to a request queue.",
"required": [
"requestId",
"uniqueKey",
"wasAlreadyHandled",
"wasAlreadyPresent"
],
"type": "object",
"properties": {
"requestId": {
"$ref": "#/components/schemas/RequestId"
},
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"wasAlreadyPresent": {
"$ref": "#/components/schemas/WasAlreadyPresent"
},
"wasAlreadyHandled": {
"$ref": "#/components/schemas/WasAlreadyHandled"
}
}
},
"RequestDraft": {
"title": "RequestDraft",
"description": "A request that failed to be processed during a request queue operation and can be retried.",
"required": [
"uniqueKey",
"url"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/RequestId"
},
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"url": {
"$ref": "#/components/schemas/RequestUrl"
},
"method": {
"$ref": "#/components/schemas/RequestMethod"
}
}
},
"BatchAddResult": {
"title": "BatchAddResult",
"description": "Result of a batch add operation containing successfully processed and failed requests.",
"type": "object",
"required": [
"processedRequests",
"unprocessedRequests"
],
"properties": {
"processedRequests": {
"type": "array",
"description": "Requests that were successfully added to the request queue.",
"items": {
"$ref": "#/components/schemas/AddedRequest"
}
},
"unprocessedRequests": {
"type": "array",
"description": "Requests that failed to be added and can be retried.",
"items": {
"$ref": "#/components/schemas/RequestDraft"
}
}
}
},
"BatchAddResponse": {
"title": "BatchAddResponse",
"description": "Response containing the result of a batch add operation.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BatchAddResult"
}
},
"example": {
"data": {
"processedRequests": [
{
"requestId": "YiKoxjkaS9gjGTqhF",
"uniqueKey": "http://example.com",
"wasAlreadyPresent": true,
"wasAlreadyHandled": false
}
],
"unprocessedRequests": [
{
"uniqueKey": "http://example.com/2",
"url": "http://example.com/2",
"method": "GET"
}
]
}
}
},
"RequestDraftDeleteById": {
"title": "RequestDraftDeleteById",
"description": "A request that should be deleted, identified by its ID.",
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/RequestId"
},
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
}
}
},
"RequestDraftDeleteByUniqueKey": {
"title": "RequestDraftDeleteByUniqueKey",
"description": "A request that should be deleted, identified by its unique key.",
"type": "object",
"required": [
"uniqueKey"
],
"properties": {
"id": {
"$ref": "#/components/schemas/RequestId"
},
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
}
}
},
"RequestDraftDelete": {
"title": "RequestDraftDelete",
"description": "A request that should be deleted.",
"anyOf": [
{
"$ref": "#/components/schemas/RequestDraftDeleteById"
},
{
"$ref": "#/components/schemas/RequestDraftDeleteByUniqueKey"
}
]
},
"DeletedRequestById": {
"title": "DeletedRequestById",
"description": "Confirmation of a request that was successfully deleted, identified by its ID.",
"type": "object",
"required": [
"id"
],
"properties": {
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"id": {
"$ref": "#/components/schemas/RequestId"
}
}
},
"DeletedRequestByUniqueKey": {
"title": "DeletedRequestByUniqueKey",
"description": "Confirmation of a request that was successfully deleted, identified by its unique key.",
"type": "object",
"required": [
"uniqueKey"
],
"properties": {
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"id": {
"$ref": "#/components/schemas/RequestId"
}
}
},
"DeletedRequest": {
"title": "DeletedRequest",
"description": "Confirmation of a request that was successfully deleted from a request queue.",
"anyOf": [
{
"$ref": "#/components/schemas/DeletedRequestById"
},
{
"$ref": "#/components/schemas/DeletedRequestByUniqueKey"
}
]
},
"BatchDeleteResult": {
"title": "BatchDeleteResult",
"description": "Result of a batch delete operation containing successfully deleted and failed requests.",
"type": "object",
"required": [
"processedRequests",
"unprocessedRequests"
],
"properties": {
"processedRequests": {
"type": "array",
"description": "Requests that were successfully deleted from the request queue.",
"items": {
"$ref": "#/components/schemas/DeletedRequest"
}
},
"unprocessedRequests": {
"type": "array",
"description": "Requests that failed to be deleted and can be retried.",
"items": {
"$ref": "#/components/schemas/RequestDraft"
}
}
}
},
"BatchDeleteResponse": {
"title": "BatchDeleteResponse",
"description": "Response containing the result of a batch delete operation.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BatchDeleteResult"
}
}
},
"UnlockRequestsResult": {
"title": "UnlockRequestsResult",
"description": "Result of unlocking requests in the request queue.",
"type": "object",
"required": [
"unlockedCount"
],
"properties": {
"unlockedCount": {
"type": "integer",
"description": "Number of requests that were successfully unlocked.",
"examples": [
10
]
}
}
},
"UnlockRequestsResponse": {
"title": "UnlockRequestsResponse",
"description": "Response containing the result of unlocking requests.",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/UnlockRequestsResult"
}
}
},
"RequestResponse": {
"title": "RequestResponse",
"description": "Response containing a single request from the request queue.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Request"
}
}
},
"UpdateRequestResponse": {
"title": "UpdateRequestResponse",
"description": "Response containing the result of updating a request in the request queue.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RequestRegistration"
}
}
},
"LockExpiresAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the lock on this request expires.",
"examples": [
"2022-06-14T23:00:00.000Z"
]
},
"RequestLockInfo": {
"title": "RequestLockInfo",
"description": "Information about a request lock.",
"type": "object",
"required": [
"lockExpiresAt"
],
"properties": {
"lockExpiresAt": {
"$ref": "#/components/schemas/LockExpiresAt"
}
}
},
"ProlongRequestLockResponse": {
"title": "ProlongRequestLockResponse",
"description": "Response containing updated lock information after prolonging a request lock.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RequestLockInfo"
}
}
},
"HeadLimit": {
"type": "integer",
"description": "The maximum number of requests returned.",
"examples": [
1000
]
},
"HeadRequest": {
"title": "HeadRequest",
"description": "A request from the request queue head without lock information.",
"type": "object",
"required": [
"id",
"uniqueKey",
"url"
],
"properties": {
"id": {
"$ref": "#/components/schemas/RequestId"
},
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"url": {
"$ref": "#/components/schemas/RequestUrl"
},
"method": {
"$ref": "#/components/schemas/RequestMethod"
},
"retryCount": {
"$ref": "#/components/schemas/RetryCount"
}
}
},
"RequestQueueHead": {
"title": "RequestQueueHead",
"description": "A batch of requests from the request queue head without locking.",
"type": "object",
"required": [
"limit",
"queueModifiedAt",
"hadMultipleClients",
"items"
],
"properties": {
"limit": {
"$ref": "#/components/schemas/HeadLimit"
},
"queueModifiedAt": {
"$ref": "#/components/schemas/QueueModifiedAt"
},
"hadMultipleClients": {
"$ref": "#/components/schemas/HadMultipleClients"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HeadRequest"
},
"description": "The array of requests from the request queue head."
}
}
},
"HeadResponse": {
"title": "HeadResponse",
"description": "Response containing requests from the request queue head without locking.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RequestQueueHead"
}
},
"example": {
"data": {
"limit": 1000,
"queueModifiedAt": "2018-03-14T23:00:00.000Z",
"hadMultipleClients": false,
"items": [
{
"id": "8OamqXBCpPHxyH9",
"retryCount": 0,
"uniqueKey": "http://example.com",
"url": "http://example.com",
"method": "GET"
},
{
"id": "ZJAoqlRijenMQIn",
"retryCount": 0,
"uniqueKey": "http://example.com/a/b",
"url": "http://example.com/a/b",
"method": "GET"
},
{
"id": "hAhkwyk5oOBHKQC",
"retryCount": 1,
"uniqueKey": "http://example.com/c/d",
"url": "http://example.com/c/d",
"method": "GET"
}
]
}
}
},
"LockedHeadRequest": {
"title": "LockedHeadRequest",
"description": "A request from the request queue head that has been locked for processing.",
"type": "object",
"required": [
"id",
"uniqueKey",
"url",
"lockExpiresAt"
],
"properties": {
"id": {
"$ref": "#/components/schemas/RequestId"
},
"uniqueKey": {
"$ref": "#/components/schemas/UniqueKey"
},
"url": {
"$ref": "#/components/schemas/RequestUrl"
},
"method": {
"$ref": "#/components/schemas/RequestMethod"
},
"retryCount": {
"$ref": "#/components/schemas/RetryCount"
},
"lockExpiresAt": {
"$ref": "#/components/schemas/LockExpiresAt"
}
}
},
"LockedRequestQueueHead": {
"title": "LockedRequestQueueHead",
"description": "A batch of locked requests from the request queue head.",
"type": "object",
"required": [
"limit",
"queueModifiedAt",
"hadMultipleClients",
"lockSecs",
"items"
],
"properties": {
"limit": {
"$ref": "#/components/schemas/HeadLimit"
},
"queueModifiedAt": {
"$ref": "#/components/schemas/QueueModifiedAt"
},
"queueHasLockedRequests": {
"type": "boolean",
"description": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one).",
"examples": [
true
]
},
"clientKey": {
"type": "string",
"description": "The client key used for locking the requests.",
"examples": [
"client-one"
]
},
"hadMultipleClients": {
"$ref": "#/components/schemas/HadMultipleClients"
},
"lockSecs": {
"type": "integer",
"description": "The number of seconds the locks will be held.",
"examples": [
60
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LockedHeadRequest"
},
"description": "The array of locked requests from the request queue head."
}
}
},
"HeadAndLockResponse": {
"title": "HeadAndLockResponse",
"description": "Response containing locked requests from the request queue head.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LockedRequestQueueHead"
}
},
"example": {
"data": {
"limit": 3,
"queueModifiedAt": "2018-03-14T23:00:00.000Z",
"hadMultipleClients": true,
"lockSecs": 60,
"items": [
{
"id": "8OamqXBCpPHxyj9",
"retryCount": 0,
"uniqueKey": "http://example.com",
"url": "http://example.com",
"method": "GET",
"lockExpiresAt": "2022-06-14T23:00:00.000Z"
},
{
"id": "8OamqXBCpPHxyx9",
"retryCount": 0,
"uniqueKey": "http://example.com/a",
"url": "http://example.com/a",
"method": "GET",
"lockExpiresAt": "2022-06-14T23:00:00.000Z"
},
{
"id": "8OamqXBCpPHxy08",
"retryCount": 0,
"uniqueKey": "http://example.com/a/b",
"url": "http://example.com/a/b",
"method": "GET",
"lockExpiresAt": "2022-06-14T23:00:00.000Z"
}
]
}
}
},
"TaskStats": {
"title": "TaskStats",
"type": "object",
"properties": {
"totalRuns": {
"type": "integer",
"examples": [
15
]
}
}
},
"TaskShort": {
"title": "TaskShort",
"required": [
"id",
"userId",
"actId",
"name",
"createdAt",
"modifiedAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"zdc3Pyhyz3m8vjDeM"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"actId": {
"type": "string",
"examples": [
"asADASadYvn4mBZmm"
]
},
"actName": {
"type": [
"string",
"null"
],
"examples": [
"my-actor"
]
},
"name": {
"type": "string",
"examples": [
"my-task"
]
},
"username": {
"type": [
"string",
"null"
],
"examples": [
"janedoe"
]
},
"actUsername": {
"type": [
"string",
"null"
],
"examples": [
"janedoe"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2018-10-26T07:23:14.855Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2018-10-26T13:30:49.578Z"
]
},
"stats": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskStats"
},
{
"type": "null"
}
]
}
}
},
"ListOfTasks": {
"title": "ListOfTasks",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskShort"
}
}
}
}
]
},
"ListOfTasksResponse": {
"title": "ListOfTasksResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfTasks"
}
}
},
"TaskOptions": {
"title": "TaskOptions",
"type": "object",
"properties": {
"build": {
"type": [
"string",
"null"
],
"examples": [
"latest"
]
},
"timeoutSecs": {
"type": [
"integer",
"null"
],
"examples": [
300
]
},
"memoryMbytes": {
"type": [
"integer",
"null"
],
"examples": [
1024
]
},
"maxItems": {
"type": [
"integer",
"null"
],
"examples": [
1000
]
},
"maxTotalChargeUsd": {
"type": [
"number",
"null"
],
"examples": [
5
]
},
"restartOnError": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
}
}
},
"TaskInput": {
"title": "TaskInput",
"description": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run.\n",
"type": "object",
"additionalProperties": true,
"example": {
"startUrls": [
{
"url": "https://example.com"
}
],
"maxRequestsPerCrawl": 100
}
},
"TaskPublicConfig": {
"title": "TaskPublicConfig",
"type": "object",
"description": "Public-facing configuration of a published task, used by the task's public landing page.\nThe task's publication state is determined by `publishedAt` - a task is published when\n`publishedAt` is set and unpublished when it is `null`.\n",
"properties": {
"publishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true,
"description": "Time when the task was published, or `null` if the task isn't published.\nThis field is server-controlled. To publish or unpublish a task, use the\n[Update task](/api/v2/actor-task-put) endpoint and set `isPublic`.\n",
"examples": [
"2025-06-16T09:20:45.777Z"
]
},
"seoTitle": {
"type": [
"string",
"null"
],
"maxLength": 60,
"description": "Name of the Actor task to display by search engines such as Google. Defaults to the task\ntitle. At most 60 characters.\n",
"examples": [
"Scrape data from a website"
]
},
"seoDescription": {
"type": [
"string",
"null"
],
"maxLength": 160,
"description": "Description of the Actor task to display by search engines such as Google. Defaults to the\ntask description. At most 160 characters.\n"
},
"inputSchemaFields": {
"type": [
"array",
"null"
],
"description": "Names of the task input fields displayed on the public task page.",
"items": {
"type": "string"
}
},
"datasetName": {
"type": [
"string",
"null"
],
"description": "Name of the dataset from the Actor's dataset schema whose results are displayed. When\n`null`, the Actor's default dataset is used. That is, the only dataset the Actor declares,\nor the one named `default` when it declares several.\n"
},
"datasetView": {
"type": [
"string",
"null"
],
"description": "Key of the dataset view from the Actor's dataset schema used to display results. Must be\none of the views declared on the resolved dataset. You can't publish a task without it.\n"
}
}
},
"CreateTaskRequest": {
"title": "CreateTaskRequest",
"required": [
"actId"
],
"type": "object",
"properties": {
"actId": {
"type": "string",
"examples": [
"asADASadYvn4mBZmm"
]
},
"name": {
"type": "string",
"examples": [
"my-task"
]
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskOptions"
},
{
"type": "null"
}
]
},
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskInput"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskInput"
}
},
{
"type": "null"
}
]
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"actorStandby": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStandby"
},
{
"type": "null"
}
]
},
"publicConfig": {
"description": "Configuration that controls how the published task appears on its public landing page.\nEditing this object requires write permission to the Actor that the task belongs to.\n",
"$ref": "#/components/schemas/TaskPublicConfig"
}
}
},
"Task": {
"title": "Task",
"required": [
"id",
"userId",
"actId",
"name",
"createdAt",
"modifiedAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"zdc3Pyhyz3m8vjDeM"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"actId": {
"type": "string",
"examples": [
"asADASadYvn4mBZmm"
]
},
"name": {
"type": "string",
"examples": [
"my-task"
]
},
"username": {
"type": [
"string",
"null"
],
"examples": [
"janedoe"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2018-10-26T07:23:14.855Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2018-10-26T13:30:49.578Z"
]
},
"removedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"stats": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskStats"
},
{
"type": "null"
}
]
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskOptions"
},
{
"type": "null"
}
]
},
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskInput"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskInput"
}
},
{
"type": "null"
}
]
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"actorStandby": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStandby"
},
{
"type": "null"
}
]
},
"standbyUrl": {
"type": [
"string",
"null"
],
"format": "uri"
},
"isPublic": {
"type": "boolean",
"description": "Whether the task is published. Based on the `publicConfig.publishedAt` field.\n",
"examples": [
false
]
},
"publicConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskPublicConfig"
},
{
"type": "null"
}
]
}
}
},
"TaskResponse": {
"title": "TaskResponse",
"description": "Response containing Actor task data.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Task"
}
},
"example": {
"data": {
"id": "zdc3Pyhyz3m8vjDeM",
"userId": "wRsJZtadYvn4mBZmm",
"actId": "asADASadYvn4mBZmm",
"name": "my-task",
"username": "janedoe",
"createdAt": "2018-10-26T07:23:14.855Z",
"modifiedAt": "2018-10-26T13:30:49.578Z",
"removedAt": null,
"stats": {
"totalRuns": 15
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 128
},
"input": {
"hello": "world"
}
}
}
},
"UpdateTaskRequest": {
"title": "UpdateTaskRequest",
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"my-task"
]
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskOptions"
},
{
"type": "null"
}
]
},
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskInput"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskInput"
}
},
{
"type": "null"
}
]
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"actorStandby": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorStandby"
},
{
"type": "null"
}
]
},
"publicConfig": {
"description": "Configuration that controls how the published task appears on its public landing page.\nEditing this object requires write permission to the Actor that the task belongs to.\n\nThe fields you send are merged into the stored configuration, so you only need to include\nthe ones you're changing. To clear a field, set it to `null`. Sending `publicConfig: null`\nis rejected, so the object as a whole can't be cleared.\n",
"$ref": "#/components/schemas/TaskPublicConfig"
},
"isPublic": {
"type": "boolean",
"description": "Set to `true` to publish the task on its public landing page, or `false` to unpublish it.\nSending the value the task already has does nothing.\n",
"examples": [
true
]
}
}
},
"Webhook": {
"title": "Webhook",
"required": [
"id",
"createdAt",
"modifiedAt",
"userId",
"eventTypes",
"condition",
"ignoreSslErrors"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"YiKoxjkaS9gjGTqhF"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"isAdHoc": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"shouldInterpolateStrings": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"eventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEventType"
},
"examples": [
[
"ACTOR.RUN.SUCCEEDED"
]
]
},
"condition": {
"$ref": "#/components/schemas/WebhookCondition"
},
"ignoreSslErrors": {
"type": "boolean",
"examples": [
false
]
},
"doNotRetry": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"requestUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL of the HTTP request sent by the webhook. It is omitted or `null` for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).",
"examples": [
"http://example.com/"
]
},
"payloadTemplate": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"userId\": {{userId}}..."
]
},
"headersTemplate": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"Authorization\": \"Bearer ...\"}"
]
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"this is webhook description"
]
},
"lastDispatch": {
"anyOf": [
{
"$ref": "#/components/schemas/ExampleWebhookDispatch"
},
{
"type": "null"
}
]
},
"stats": {
"anyOf": [
{
"$ref": "#/components/schemas/WebhookStats"
},
{
"type": "null"
}
]
}
}
},
"UpdateRunRequest": {
"title": "UpdateRunRequest",
"type": "object",
"properties": {
"runId": {
"type": "string",
"examples": [
"3KH8gEpp4d8uQSe8T"
]
},
"statusMessage": {
"type": "string",
"examples": [
"Actor has finished"
]
},
"isStatusMessageTerminal": {
"type": "boolean",
"examples": [
true
]
},
"generalAccess": {
"$ref": "#/components/schemas/GeneralAccess"
}
}
},
"ChargeRunRequest": {
"title": "ChargeRunRequest",
"required": [
"eventName",
"count"
],
"type": "object",
"properties": {
"eventName": {
"type": "string",
"examples": [
"ANALYZE_PAGE"
]
},
"count": {
"type": "integer",
"examples": [
1
]
}
}
},
"StorageOwnership": {
"type": "string",
"enum": [
"ownedByMe",
"sharedWithMe"
],
"examples": [
"ownedByMe"
]
},
"ListOfKeyValueStores": {
"title": "ListOfKeyValueStores",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"unnamed": {
"type": "boolean",
"description": "Whether the listing was filtered to only unnamed key-value stores.",
"examples": [
false
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyValueStore"
}
}
}
}
]
},
"ListOfKeyValueStoresResponse": {
"title": "ListOfKeyValueStoresResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfKeyValueStores"
}
}
},
"DatasetListItem": {
"title": "DatasetListItem",
"required": [
"id",
"name",
"userId",
"createdAt",
"modifiedAt",
"accessedAt",
"itemCount",
"cleanItemCount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"WkzbQMuFYuamGv3YF"
]
},
"name": {
"type": "string",
"examples": [
"d7b9MDYsbtX5L7XAj"
]
},
"userId": {
"type": "string",
"examples": [
"tbXmWu7GCxnyYtSiL"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-13T08:36:13.202Z"
]
},
"accessedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-14T08:36:13.202Z"
]
},
"itemCount": {
"type": "integer",
"examples": [
7
]
},
"cleanItemCount": {
"type": "integer",
"examples": [
5
]
},
"actId": {
"type": [
"string",
"null"
],
"examples": [
"zdc3Pyhyz3m8vjDeM"
]
},
"actRunId": {
"type": [
"string",
"null"
],
"examples": [
"HG7ML7M8z78YcAPEB"
]
},
"title": {
"type": [
"string",
"null"
],
"examples": [
"My Dataset"
]
},
"username": {
"type": "string",
"examples": [
"janedoe"
]
},
"generalAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/GeneralAccess"
},
{
"type": "null"
}
]
},
"stats": {
"$ref": "#/components/schemas/DatasetStats"
}
}
},
"ListOfDatasets": {
"title": "ListOfDatasets",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"unnamed": {
"type": "boolean",
"description": "Whether the listing was filtered to only unnamed datasets.",
"examples": [
false
]
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetListItem"
}
}
}
}
]
},
"ListOfDatasetsResponse": {
"title": "ListOfDatasetsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfDatasets"
}
}
},
"RequestQueueShort": {
"title": "RequestQueueShort",
"description": "A shortened request queue object for list responses.",
"required": [
"id",
"name",
"userId",
"username",
"createdAt",
"modifiedAt",
"accessedAt",
"totalRequestCount",
"handledRequestCount",
"pendingRequestCount",
"hadMultipleClients"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/QueueId"
},
"name": {
"type": "string",
"description": "The name of the request queue.",
"examples": [
"some-name"
]
},
"userId": {
"$ref": "#/components/schemas/QueueUserId"
},
"username": {
"type": "string",
"description": "The username of the user who owns the request queue.",
"examples": [
"janedoe"
]
},
"createdAt": {
"$ref": "#/components/schemas/QueueCreatedAt"
},
"modifiedAt": {
"$ref": "#/components/schemas/QueueModifiedAt"
},
"accessedAt": {
"$ref": "#/components/schemas/QueueAccessedAt"
},
"expireAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the request queue will expire and be deleted.",
"examples": [
"2019-06-02T17:15:06.751Z"
]
},
"totalRequestCount": {
"$ref": "#/components/schemas/TotalRequestCount"
},
"handledRequestCount": {
"$ref": "#/components/schemas/HandledRequestCount"
},
"pendingRequestCount": {
"$ref": "#/components/schemas/PendingRequestCount"
},
"actId": {
"type": [
"string",
"null"
],
"description": "The ID of the Actor that created this request queue."
},
"actRunId": {
"type": [
"string",
"null"
],
"description": "The ID of the Actor run that created this request queue."
},
"hadMultipleClients": {
"$ref": "#/components/schemas/HadMultipleClients"
},
"generalAccess": {
"anyOf": [
{
"$ref": "#/components/schemas/GeneralAccess"
},
{
"type": "null"
}
]
},
"stats": {
"$ref": "#/components/schemas/RequestQueueStats"
}
}
},
"ListOfRequestQueues": {
"title": "ListOfRequestQueues",
"description": "A paginated list of request queues.",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"unnamed": {
"type": "boolean",
"description": "Whether the listing was filtered to only unnamed request queues.",
"examples": [
false
]
},
"items": {
"type": "array",
"description": "The array of request queues.",
"items": {
"$ref": "#/components/schemas/RequestQueueShort"
}
}
}
}
]
},
"ListOfRequestQueuesResponse": {
"title": "ListOfRequestQueuesResponse",
"description": "Response containing a list of request queues.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfRequestQueues"
}
}
},
"WebhookCreate": {
"title": "WebhookCreate",
"required": [
"eventTypes",
"condition",
"requestUrl"
],
"type": "object",
"properties": {
"isAdHoc": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"eventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEventType"
},
"examples": [
[
"ACTOR.RUN.SUCCEEDED"
]
]
},
"condition": {
"$ref": "#/components/schemas/WebhookCondition"
},
"idempotencyKey": {
"type": [
"string",
"null"
],
"examples": [
"fdSJmdP3nfs7sfk3y"
]
},
"ignoreSslErrors": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"doNotRetry": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"requestUrl": {
"type": "string",
"examples": [
"http://example.com/"
]
},
"payloadTemplate": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"userId\": {{userId}}..."
]
},
"headersTemplate": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"Authorization\": \"Bearer ...\"}"
]
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"this is webhook description"
]
},
"shouldInterpolateStrings": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
}
}
},
"WebhookResponse": {
"title": "WebhookResponse",
"description": "Response containing webhook data.",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Webhook"
}
}
},
"WebhookUpdate": {
"title": "WebhookUpdate",
"type": "object",
"properties": {
"isAdHoc": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"eventTypes": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/WebhookEventType"
},
"description": "",
"examples": [
[
"ACTOR.RUN.SUCCEEDED"
]
]
},
"condition": {
"anyOf": [
{
"$ref": "#/components/schemas/WebhookCondition"
},
{
"type": "null"
}
]
},
"ignoreSslErrors": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"doNotRetry": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
},
"requestUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"examples": [
"http://example.com/"
]
},
"payloadTemplate": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"userId\": {{userId}}..."
]
},
"headersTemplate": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"Authorization\": \"Bearer ...\"}"
]
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"this is webhook description"
]
},
"shouldInterpolateStrings": {
"type": [
"boolean",
"null"
],
"examples": [
false
]
}
}
},
"WebhookDispatchWebhookSummary": {
"title": "WebhookDispatchWebhookSummary",
"description": "A summary of the webhook that triggered this dispatch.",
"type": "object",
"properties": {
"actionType": {
"type": "string",
"examples": [
"HTTP_REQUEST"
]
},
"condition": {
"$ref": "#/components/schemas/WebhookCondition"
},
"requestUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL of the HTTP request sent by the webhook. It is `null` for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).",
"examples": [
"https://example.com/webhook"
]
},
"isAdHoc": {
"type": "boolean",
"examples": [
false
]
}
}
},
"WebhookDispatch": {
"title": "WebhookDispatch",
"required": [
"id",
"userId",
"webhookId",
"createdAt",
"status",
"eventType"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"asdLZtadYvn4mBZmm"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"webhookId": {
"type": "string",
"examples": [
"asdLZtadYvn4mBZmm"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"status": {
"$ref": "#/components/schemas/WebhookDispatchStatus"
},
"eventType": {
"$ref": "#/components/schemas/WebhookEventType"
},
"eventData": {
"title": "eventData",
"type": [
"object",
"null"
],
"required": [
"actorId"
],
"properties": {
"actorId": {
"type": "string",
"examples": [
"vvE7iMKuMc5qTHHsR"
]
},
"actorRunId": {
"type": "string",
"examples": [
"JgwXN9BdwxGcu9MMF"
]
},
"actorBuildId": {
"type": "string",
"examples": [
"HG7ML7M8z78YcAPEB"
]
},
"actorTaskId": {
"type": [
"string",
"null"
],
"examples": [
"zRLp8SDOZz2NyLg7K"
]
}
}
},
"webhook": {
"anyOf": [
{
"$ref": "#/components/schemas/WebhookDispatchWebhookSummary"
},
{
"type": "null"
}
]
},
"calls": {
"title": "calls",
"type": "array",
"items": {
"type": "object",
"properties": {
"startedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"finishedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"errorMessage": {
"type": [
"string",
"null"
],
"examples": [
"Cannot send request"
]
},
"responseStatus": {
"type": [
"integer",
"null"
],
"examples": [
200
]
},
"responseBody": {
"type": [
"string",
"null"
],
"example": "{\"foo\": \"bar\"}"
}
}
}
}
}
},
"TestWebhookResponse": {
"title": "TestWebhookResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookDispatch"
}
}
},
"ListOfWebhookDispatches": {
"title": "ListOfWebhookDispatches",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookDispatch"
}
}
}
}
]
},
"ListOfWebhookDispatchesResponse": {
"title": "ListOfWebhookDispatchesResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfWebhookDispatches"
}
}
},
"WebhookDispatchResponse": {
"title": "WebhookDispatchResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookDispatch"
}
}
},
"ScheduleBase": {
"title": "ScheduleBase",
"required": [
"id",
"userId",
"name",
"cronExpression",
"timezone",
"isEnabled",
"isExclusive",
"createdAt",
"modifiedAt"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"asdLZtadYvn4mBZmm"
]
},
"userId": {
"type": "string",
"examples": [
"wRsJZtadYvn4mBZmm"
]
},
"name": {
"type": "string",
"examples": [
"my-schedule"
]
},
"cronExpression": {
"type": "string",
"examples": [
"* * * * *"
]
},
"timezone": {
"type": "string",
"examples": [
"UTC"
]
},
"isEnabled": {
"type": "boolean",
"examples": [
true
]
},
"isExclusive": {
"type": "boolean",
"examples": [
true
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-12T07:34:14.202Z"
]
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-12-20T06:33:11.202Z"
]
},
"nextRunAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-04-12T07:34:10.202Z"
]
},
"lastRunAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2019-04-12T07:33:10.202Z"
]
}
}
},
"ScheduleActionShortRunActor": {
"title": "ScheduleActionShortRunActor",
"required": [
"id",
"type",
"actorId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"ZReCs7hkdieq8ZUki"
]
},
"type": {
"const": "RUN_ACTOR"
},
"actorId": {
"type": "string",
"examples": [
"HKhKmiCMrDgu9eXeE"
]
}
}
},
"ScheduleActionShortRunActorTask": {
"title": "ScheduleActionShortRunActorTask",
"required": [
"id",
"type",
"actorTaskId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"ZReCs7hkdieq8ZUki"
]
},
"type": {
"const": "RUN_ACTOR_TASK"
},
"actorTaskId": {
"type": "string",
"examples": [
"HKhKmiCMrDgu9eXeE"
]
}
}
},
"ScheduleActionShort": {
"title": "ScheduleActionShort",
"oneOf": [
{
"$ref": "#/components/schemas/ScheduleActionShortRunActor"
},
{
"$ref": "#/components/schemas/ScheduleActionShortRunActorTask"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"RUN_ACTOR": "#/components/schemas/ScheduleActionShortRunActor",
"RUN_ACTOR_TASK": "#/components/schemas/ScheduleActionShortRunActorTask"
}
}
},
"ScheduleShort": {
"title": "ScheduleShort",
"allOf": [
{
"$ref": "#/components/schemas/ScheduleBase"
},
{
"type": "object",
"required": [
"actions"
],
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleActionShort"
},
"description": ""
}
}
}
]
},
"ListOfSchedules": {
"title": "ListOfSchedules",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleShort"
}
}
}
}
]
},
"ListOfSchedulesResponse": {
"title": "ListOfSchedulesResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfSchedules"
}
}
},
"ScheduleActionRunInput": {
"title": "ScheduleActionRunInput",
"type": "object",
"properties": {
"body": {
"type": [
"string",
"null"
],
"examples": [
"{\\n \"foo\": \"actor\"\\n}"
]
},
"contentType": {
"type": [
"string",
"null"
],
"examples": [
"application/json; charset=utf-8"
]
}
}
},
"ScheduleCreateActionRunActor": {
"title": "ScheduleCreateActionRunActor",
"required": [
"type",
"actorId"
],
"type": "object",
"properties": {
"type": {
"const": "RUN_ACTOR"
},
"actorId": {
"type": "string",
"examples": [
"jF8GGEvbEg4Au3NLA"
]
},
"runInput": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleActionRunInput"
},
{
"type": "null"
}
]
},
"runOptions": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskOptions"
},
{
"type": "null"
}
]
}
}
},
"ScheduleCreateActionRunActorTask": {
"title": "ScheduleCreateActionRunActorTask",
"required": [
"type",
"actorTaskId"
],
"type": "object",
"properties": {
"type": {
"const": "RUN_ACTOR_TASK"
},
"actorTaskId": {
"type": "string",
"examples": [
"jF8GGEvbEg4Au3NLA"
]
},
"input": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
}
},
"ScheduleCreateAction": {
"title": "ScheduleCreateAction",
"oneOf": [
{
"$ref": "#/components/schemas/ScheduleCreateActionRunActor"
},
{
"$ref": "#/components/schemas/ScheduleCreateActionRunActorTask"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"RUN_ACTOR": "#/components/schemas/ScheduleCreateActionRunActor",
"RUN_ACTOR_TASK": "#/components/schemas/ScheduleCreateActionRunActorTask"
}
}
},
"ScheduleCreate": {
"title": "ScheduleCreate",
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"examples": [
"my-schedule"
]
},
"isEnabled": {
"type": [
"boolean",
"null"
],
"examples": [
true
]
},
"isExclusive": {
"type": [
"boolean",
"null"
],
"examples": [
true
]
},
"cronExpression": {
"type": [
"string",
"null"
],
"examples": [
"* * * * *"
]
},
"timezone": {
"type": [
"string",
"null"
],
"examples": [
"UTC"
]
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"Schedule of actor ..."
]
},
"title": {
"type": [
"string",
"null"
]
},
"actions": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ScheduleCreateAction"
},
"description": ""
}
}
},
"ScheduleActionRunActor": {
"title": "ScheduleActionRunActor",
"required": [
"id",
"type",
"actorId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"c6KfSgoQzFhMk3etc"
]
},
"type": {
"const": "RUN_ACTOR"
},
"actorId": {
"type": "string",
"examples": [
"jF8GGEvbEg4Au3NLA"
]
},
"runInput": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleActionRunInput"
},
{
"type": "null"
}
]
},
"runOptions": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskOptions"
},
{
"type": "null"
}
]
}
}
},
"ScheduleActionRunActorTask": {
"title": "ScheduleActionRunActorTask",
"required": [
"id",
"type",
"actorTaskId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"c6KfSgoQzFhMk3etc"
]
},
"type": {
"const": "RUN_ACTOR_TASK"
},
"actorTaskId": {
"type": "string",
"examples": [
"jF8GGEvbEg4Au3NLA"
]
},
"input": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
}
},
"ScheduleAction": {
"title": "ScheduleAction",
"oneOf": [
{
"$ref": "#/components/schemas/ScheduleActionRunActor"
},
{
"$ref": "#/components/schemas/ScheduleActionRunActorTask"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"RUN_ACTOR": "#/components/schemas/ScheduleActionRunActor",
"RUN_ACTOR_TASK": "#/components/schemas/ScheduleActionRunActorTask"
}
}
},
"Schedule": {
"title": "Schedule",
"allOf": [
{
"$ref": "#/components/schemas/ScheduleBase"
},
{
"type": "object",
"required": [
"actions"
],
"properties": {
"description": {
"type": [
"string",
"null"
],
"examples": [
"Schedule of actor ..."
]
},
"title": {
"type": [
"string",
"null"
]
},
"notifications": {
"title": "ScheduleNotifications",
"type": "object",
"description": "Notification settings for this schedule.",
"properties": {
"email": {
"type": "boolean",
"examples": [
true
]
}
}
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleAction"
},
"description": ""
}
}
}
]
},
"ScheduleResponse": {
"title": "ScheduleResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Schedule"
}
}
},
"ScheduleInvoked": {
"title": "ScheduleInvoked",
"required": [
"message",
"level",
"createdAt"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"examples": [
"Schedule invoked"
]
},
"level": {
"type": "string",
"examples": [
"INFO"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2019-03-26T12:28:00.370Z"
]
}
}
},
"ScheduleLogResponse": {
"title": "ScheduleLogResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleInvoked"
},
"description": ""
}
}
},
"CurrentPricingInfo": {
"title": "CurrentPricingInfo",
"required": [
"pricingModel"
],
"type": "object",
"properties": {
"pricingModel": {
"type": "string",
"examples": [
"FREE"
]
},
"apifyMarginPercentage": {
"type": "number",
"examples": [
0.2
],
"description": "Apify's share of the revenue generated under this pricing info record, as a fraction between 0 and 1. Set by the Apify platform.\n"
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2023-01-01T00:00:00.000Z"
]
},
"startedAt": {
"type": "string",
"format": "date-time",
"examples": [
"2023-01-01T00:00:00.000Z"
]
},
"notifiedAboutChangeAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
null
]
},
"notifiedAboutFutureChangeAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
null
]
},
"isPriceChangeNotificationSuppressed": {
"type": "boolean",
"examples": [
false
]
},
"forceContainsSignificantPriceChange": {
"type": "boolean",
"examples": [
false
]
},
"isPPEPlatformUsagePaidByUser": {
"type": "boolean",
"examples": [
false
]
},
"reasonForChange": {
"type": [
"string",
"null"
],
"examples": [
null
]
},
"trialMinutes": {
"type": [
"integer",
"null"
],
"examples": [
null
]
},
"unitName": {
"type": [
"string",
"null"
],
"examples": [
null
]
},
"pricePerUnitUsd": {
"type": [
"number",
"null"
],
"examples": [
null
]
},
"minimalMaxTotalChargeUsd": {
"type": [
"number",
"null"
],
"examples": [
0.5
]
},
"pricingPerEvent": {
"type": [
"object",
"null"
],
"description": "Per-event pricing configuration for pay-per-event Actors.",
"additionalProperties": true
}
}
},
"StoreListActor": {
"title": "StoreListActor",
"required": [
"id",
"title",
"name",
"username",
"stats"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"zdc3Pyhyz3m8vjDeM"
]
},
"title": {
"type": "string",
"examples": [
"My Public Actor"
]
},
"name": {
"type": "string",
"examples": [
"my-public-actor"
]
},
"username": {
"type": "string",
"examples": [
"jane35"
]
},
"userFullName": {
"type": [
"string",
"null"
],
"examples": [
"Jane H. Doe"
]
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"My public actor!"
]
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"MARKETING",
"LEAD_GENERATION"
]
},
"notice": {
"$ref": "#/components/schemas/ActorNotice"
},
"pictureUrl": {
"type": [
"string",
"null"
],
"examples": [
"https://..."
]
},
"userPictureUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"examples": [
"https://..."
]
},
"url": {
"type": [
"string",
"null"
],
"format": "uri",
"examples": [
"https://..."
]
},
"stats": {
"$ref": "#/components/schemas/ActorStats"
},
"currentPricingInfo": {
"$ref": "#/components/schemas/CurrentPricingInfo"
},
"isWhiteListedForAgenticPayments": {
"type": [
"boolean",
"null"
],
"description": "Whether the Actor is whitelisted for agentic payment processing."
},
"actorReviewCount": {
"type": "integer",
"examples": [
69
]
},
"actorReviewRating": {
"type": "number",
"examples": [
4.7
]
},
"bookmarkCount": {
"type": "integer",
"examples": [
1269
]
},
"badge": {
"type": [
"string",
"null"
],
"examples": [
null
]
},
"readmeSummary": {
"type": "string",
"description": "A brief, LLM-generated readme summary"
}
}
},
"ListOfStoreActors": {
"title": "ListOfStoreActors",
"allOf": [
{
"$ref": "#/components/schemas/PaginationResponse"
},
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoreListActor"
}
}
}
}
]
},
"ListOfActorsInStoreResponse": {
"title": "ListOfActorsInStoreResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ListOfStoreActors"
}
},
"example": {
"data": {
"total": 100,
"offset": 0,
"limit": 1000,
"desc": false,
"count": 1,
"items": [
{
"id": "zdc3Pyhyz3m8vjDeM",
"title": "My Public Actor",
"name": "my-public-actor",
"username": "jane35",
"userFullName": "Jane Doe",
"description": "My public Actor!",
"pictureUrl": "https://...",
"userPictureUrl": "https://...",
"url": "https://...",
"stats": {
"totalBuilds": 9,
"totalRuns": 16,
"totalUsers": 6,
"totalUsers7Days": 2,
"totalUsers30Days": 6,
"totalUsers90Days": 6,
"totalMetamorphs": 2,
"lastRunStartedAt": "2019-07-08T14:01:05.546Z"
},
"currentPricingInfo": {
"pricingModel": "FREE"
},
"isWhiteListedForAgenticPayments": true
},
{
"id": "zdc3Pyhyz3m8vjDeM",
"title": "My Public Actor",
"name": "my-public-actor",
"username": "jane35",
"userFullName": "Jane H. Doe",
"categories": [
"MARKETING",
"LEAD_GENERATION"
],
"description": "My public Actor!",
"pictureUrl": "https://...",
"userPictureUrl": "https://...",
"url": "https://...",
"stats": {
"totalBuilds": 9,
"totalRuns": 16,
"totalUsers": 6,
"totalUsers7Days": 2,
"totalUsers30Days": 6,
"totalUsers90Days": 6,
"totalMetamorphs": 2,
"lastRunStartedAt": "2019-07-08T14:01:05.546Z"
},
"currentPricingInfo": {
"pricingModel": "FREE"
},
"isWhiteListedForAgenticPayments": false
}
]
}
}
},
"Profile": {
"title": "Profile",
"type": "object",
"properties": {
"bio": {
"type": [
"string",
"null"
],
"examples": [
"I started web scraping in 1985 using Altair BASIC."
]
},
"name": {
"type": "string",
"examples": [
"Jane Doe"
]
},
"pictureUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"examples": [
"https://apify.com/img/anonymous_user_picture.png"
]
},
"githubUsername": {
"type": [
"string",
"null"
],
"examples": [
"torvalds."
]
},
"websiteUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"examples": [
"http://www.example.com"
]
},
"twitterUsername": {
"type": [
"string",
"null"
],
"examples": [
"@BillGates"
]
}
}
},
"UserPublicInfo": {
"title": "UserPublicInfo",
"required": [
"username"
],
"type": "object",
"properties": {
"username": {
"type": "string",
"examples": [
"d7b9MDYsbtX5L7XAj"
]
},
"profile": {
"$ref": "#/components/schemas/Profile"
}
}
},
"PublicUserDataResponse": {
"title": "PublicUserDataResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserPublicInfo"
}
}
},
"ProxyGroup": {
"title": "ProxyGroup",
"required": [
"name",
"description",
"availableCount"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"Group1"
]
},
"description": {
"type": [
"string",
"null"
],
"examples": [
"Group1 description"
]
},
"availableCount": {
"type": "integer",
"examples": [
10
]
}
}
},
"Proxy": {
"title": "Proxy",
"required": [
"password",
"groups"
],
"type": "object",
"properties": {
"password": {
"type": "string",
"examples": [
"ad78knd9Jkjd86"
]
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProxyGroup"
}
}
}
},
"AvailableProxyGroups": {
"title": "AvailableProxyGroups",
"description": "A dictionary mapping proxy group names to the number of available proxies in each group.\nThe keys are proxy group names (e.g., \"RESIDENTIAL\", \"DATACENTER\") and values are\nthe count of available proxies.\n",
"type": "object",
"additionalProperties": {
"type": "integer",
"description": "The number of available proxies in this group."
},
"example": {
"RESIDENTIAL": 1000,
"DATACENTER": 500,
"GOOGLE_SERP": 200
}
},
"Plan": {
"title": "Plan",
"required": [
"availableProxyGroups"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"Personal"
]
},
"description": {
"type": "string",
"examples": [
"Cost-effective plan for freelancers, developers and students."
]
},
"isEnabled": {
"type": "boolean",
"examples": [
true
]
},
"monthlyBasePriceUsd": {
"type": "number",
"examples": [
49
]
},
"monthlyUsageCreditsUsd": {
"type": "number",
"examples": [
49
]
},
"usageDiscountPercent": {
"type": "number",
"examples": [
0
]
},
"enabledPlatformFeatures": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ACTORS",
"STORAGE",
"PROXY_SERPS",
"SCHEDULER",
"WEBHOOKS"
]
},
"maxMonthlyUsageUsd": {
"type": "number",
"examples": [
9999
]
},
"maxActorMemoryGbytes": {
"type": "number",
"examples": [
32
]
},
"maxMonthlyActorComputeUnits": {
"type": "number",
"examples": [
1000
]
},
"maxMonthlyResidentialProxyGbytes": {
"type": "number",
"examples": [
10
]
},
"maxMonthlyProxySerps": {
"type": "integer",
"examples": [
30000
]
},
"maxMonthlyExternalDataTransferGbytes": {
"type": "number",
"examples": [
1000
]
},
"maxActorCount": {
"type": "integer",
"examples": [
100
]
},
"maxActorTaskCount": {
"type": "integer",
"examples": [
1000
]
},
"dataRetentionDays": {
"type": "integer",
"examples": [
14
]
},
"availableProxyGroups": {
"$ref": "#/components/schemas/AvailableProxyGroups"
},
"teamAccountSeatCount": {
"type": "integer",
"examples": [
1
]
},
"supportLevel": {
"type": "string",
"examples": [
"COMMUNITY"
]
},
"availableAddOns": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[]
]
},
"tier": {
"type": "string",
"examples": [
"FREE"
]
},
"apiRateLimitBoosts": {
"type": "integer",
"examples": [
0
]
},
"maxScheduleCount": {
"type": "integer",
"examples": [
100
]
},
"maxConcurrentActorRuns": {
"type": "integer",
"examples": [
25
]
},
"planPricing": {
"type": "object",
"description": "Pricing details for this plan.",
"additionalProperties": true
}
}
},
"EffectivePlatformFeature": {
"title": "EffectivePlatformFeature",
"required": [
"isEnabled",
"disabledReason",
"disabledReasonType",
"isTrial",
"trialExpirationAt"
],
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean",
"examples": [
true
]
},
"disabledReason": {
"type": [
"string",
"null"
],
"examples": [
"The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com"
]
},
"disabledReasonType": {
"type": [
"string",
"null"
],
"examples": [
"DISABLED"
]
},
"isTrial": {
"type": "boolean",
"examples": [
false
]
},
"trialExpirationAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"examples": [
"2025-01-01T14:00:00.000Z"
]
}
}
},
"EffectivePlatformFeatures": {
"title": "EffectivePlatformFeatures",
"required": [
"ACTORS",
"STORAGE",
"SCHEDULER",
"PROXY",
"PROXY_EXTERNAL_ACCESS",
"PROXY_RESIDENTIAL",
"PROXY_SERPS",
"WEBHOOKS",
"ACTORS_PUBLIC_ALL",
"ACTORS_PUBLIC_DEVELOPER"
],
"type": "object",
"properties": {
"ACTORS": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"STORAGE": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"SCHEDULER": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"PROXY": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"PROXY_EXTERNAL_ACCESS": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"PROXY_RESIDENTIAL": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"PROXY_SERPS": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"WEBHOOKS": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"ACTORS_PUBLIC_ALL": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
},
"ACTORS_PUBLIC_DEVELOPER": {
"$ref": "#/components/schemas/EffectivePlatformFeature"
}
}
},
"UserPrivateInfo": {
"title": "UserPrivateInfo",
"required": [
"username"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"examples": [
"YiKoxjkaS9gjGTqhF"
]
},
"username": {
"type": "string",
"examples": [
"myusername"
]
},
"profile": {
"$ref": "#/components/schemas/Profile"
},
"email": {
"type": "string",
"format": "email",
"examples": [
"bob@example.com"
]
},
"proxy": {
"$ref": "#/components/schemas/Proxy"
},
"plan": {
"$ref": "#/components/schemas/Plan"
},
"effectivePlatformFeatures": {
"$ref": "#/components/schemas/EffectivePlatformFeatures"
},
"createdAt": {
"type": "string",
"format": "date-time",
"examples": [
"2022-11-29T14:48:29.381Z"
]
},
"isPaying": {
"type": "boolean",
"examples": [
true
]
}
}
},
"PrivateUserDataResponse": {
"title": "PrivateUserDataResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/UserPrivateInfo"
}
}
},
"UsageCycle": {
"title": "UsageCycle",
"required": [
"startAt",
"endAt"
],
"type": "object",
"properties": {
"startAt": {
"type": "string",
"format": "date-time",
"examples": [
"2022-10-02T00:00:00.000Z"
]
},
"endAt": {
"type": "string",
"format": "date-time",
"examples": [
"2022-11-01T23:59:59.999Z"
]
}
}
},
"PriceTiers": {
"title": "PriceTiers",
"required": [
"quantityAbove",
"discountPercent",
"tierQuantity",
"unitPriceUsd",
"priceUsd"
],
"type": "object",
"properties": {
"quantityAbove": {
"type": "number",
"examples": [
0
]
},
"discountPercent": {
"type": "number",
"examples": [
100
]
},
"tierQuantity": {
"type": "number",
"examples": [
0.39
]
},
"unitPriceUsd": {
"type": "number",
"examples": [
0
]
},
"priceUsd": {
"type": "number",
"examples": [
0
]
}
}
},
"UsageItem": {
"title": "UsageItem",
"required": [
"quantity",
"baseAmountUsd"
],
"type": "object",
"properties": {
"quantity": {
"type": "number",
"examples": [
2.784475
]
},
"baseAmountUsd": {
"type": "number",
"examples": [
0.69611875
]
},
"baseUnitPriceUsd": {
"type": "number",
"examples": [
0.25
]
},
"amountAfterVolumeDiscountUsd": {
"type": "number",
"examples": [
0.69611875
]
},
"priceTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceTiers"
},
"description": ""
}
}
},
"MonthlyServiceUsage": {
"title": "MonthlyServiceUsage",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/UsageItem"
},
"description": "A map of usage item names (e.g., ACTOR_COMPUTE_UNITS) to their usage details."
},
"ServiceUsage": {
"title": "ServiceUsage",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/UsageItem"
},
"description": "A map of service usage item names to their usage details.",
"example": {
"ACTOR_COMPUTE_UNITS": {
"quantity": 60,
"baseAmountUsd": 0.00030000000000000003,
"baseUnitPriceUsd": 0.000005,
"amountAfterVolumeDiscountUsd": 0.00030000000000000003,
"priceTiers": []
}
}
},
"DailyServiceUsages": {
"title": "DailyServiceUsages",
"required": [
"date",
"serviceUsage",
"totalUsageCreditsUsd"
],
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"examples": [
"2022-10-02T00:00:00.000Z"
]
},
"serviceUsage": {
"$ref": "#/components/schemas/ServiceUsage"
},
"totalUsageCreditsUsd": {
"type": "number",
"examples": [
0.0474385791970591
]
}
}
},
"MonthlyUsage": {
"title": "MonthlyUsage",
"required": [
"usageCycle",
"monthlyServiceUsage",
"dailyServiceUsages",
"totalUsageCreditsUsdBeforeVolumeDiscount",
"totalUsageCreditsUsdAfterVolumeDiscount"
],
"type": "object",
"properties": {
"usageCycle": {
"$ref": "#/components/schemas/UsageCycle"
},
"monthlyServiceUsage": {
"$ref": "#/components/schemas/MonthlyServiceUsage"
},
"dailyServiceUsages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DailyServiceUsages"
},
"description": ""
},
"totalUsageCreditsUsdBeforeVolumeDiscount": {
"type": "number",
"examples": [
0.786143673840067
]
},
"totalUsageCreditsUsdAfterVolumeDiscount": {
"type": "number",
"examples": [
0.786143673840067
]
}
}
},
"MonthlyUsageResponse": {
"title": "MonthlyUsageResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MonthlyUsage"
}
}
},
"Limits": {
"title": "Limits",
"required": [
"maxMonthlyUsageUsd",
"maxMonthlyActorComputeUnits",
"maxMonthlyExternalDataTransferGbytes",
"maxMonthlyProxySerps",
"maxMonthlyResidentialProxyGbytes",
"maxActorMemoryGbytes",
"maxActorCount",
"maxActorTaskCount",
"maxConcurrentActorJobs",
"maxTeamAccountSeatCount",
"dataRetentionDays"
],
"type": "object",
"properties": {
"maxMonthlyUsageUsd": {
"type": "number",
"examples": [
300
]
},
"maxMonthlyActorComputeUnits": {
"type": "number",
"examples": [
1000
]
},
"maxMonthlyExternalDataTransferGbytes": {
"type": "number",
"examples": [
7
]
},
"maxMonthlyProxySerps": {
"type": "integer",
"examples": [
50
]
},
"maxMonthlyResidentialProxyGbytes": {
"type": "number",
"examples": [
0.5
]
},
"maxActorMemoryGbytes": {
"type": "number",
"examples": [
16
]
},
"maxActorCount": {
"type": "integer",
"examples": [
100
]
},
"maxActorTaskCount": {
"type": "integer",
"examples": [
1000
]
},
"maxConcurrentActorJobs": {
"type": "integer",
"examples": [
256
]
},
"maxTeamAccountSeatCount": {
"type": "integer",
"examples": [
9
]
},
"dataRetentionDays": {
"type": "integer",
"examples": [
90
]
},
"maxScheduleCount": {
"type": "integer",
"examples": [
100
]
}
}
},
"Current": {
"title": "Current",
"required": [
"monthlyUsageUsd",
"monthlyActorComputeUnits",
"monthlyExternalDataTransferGbytes",
"monthlyProxySerps",
"monthlyResidentialProxyGbytes",
"actorMemoryGbytes",
"actorCount",
"actorTaskCount",
"activeActorJobCount",
"teamAccountSeatCount"
],
"type": "object",
"properties": {
"monthlyUsageUsd": {
"type": "number",
"examples": [
43
]
},
"monthlyActorComputeUnits": {
"type": "number",
"examples": [
500.784475
]
},
"monthlyExternalDataTransferGbytes": {
"type": "number",
"examples": [
3.00861903931946
]
},
"monthlyProxySerps": {
"type": "integer",
"examples": [
34
]
},
"monthlyResidentialProxyGbytes": {
"type": "number",
"examples": [
0.4
]
},
"actorMemoryGbytes": {
"type": "number",
"examples": [
8
]
},
"actorCount": {
"type": "integer",
"examples": [
31
]
},
"actorTaskCount": {
"type": "integer",
"examples": [
130
]
},
"activeActorJobCount": {
"type": "integer",
"examples": [
0
]
},
"teamAccountSeatCount": {
"type": "integer",
"examples": [
5
]
},
"scheduleCount": {
"type": "integer",
"examples": [
77
]
}
}
},
"AccountLimits": {
"title": "AccountLimits",
"required": [
"monthlyUsageCycle",
"limits",
"current"
],
"type": "object",
"properties": {
"monthlyUsageCycle": {
"$ref": "#/components/schemas/UsageCycle"
},
"limits": {
"$ref": "#/components/schemas/Limits"
},
"current": {
"$ref": "#/components/schemas/Current"
}
}
},
"LimitsResponse": {
"title": "LimitsResponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AccountLimits"
}
}
},
"UpdateLimitsRequest": {
"title": "UpdateLimitsRequest",
"type": "object",
"properties": {
"maxMonthlyUsageUsd": {
"type": "number",
"examples": [
300
],
"description": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges.\n"
},
"dataRetentionDays": {
"type": "integer",
"examples": [
90
],
"description": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/storage#data-retention).\n"
}
}
},
"BrowserInfoResponse": {
"type": "object",
"required": [
"method",
"clientIp",
"countryCode",
"bodyLength"
],
"properties": {
"method": {
"type": "string",
"description": "HTTP method of the request.",
"example": "GET"
},
"clientIp": {
"type": [
"string",
"null"
],
"description": "IP address of the client.",
"example": "1.2.3.4"
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Two-letter country code resolved from the client IP address.",
"example": "US"
},
"bodyLength": {
"type": "integer",
"description": "Length of the request body in bytes.",
"example": 0
},
"headers": {
"type": "object",
"description": "Request headers. Omitted when `skipHeaders=true`.\n",
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"rawHeaders": {
"type": "array",
"description": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`.\n",
"items": {
"type": "string"
}
}
}
},
"EncodeAndSignData": {
"title": "EncodeAndSignData",
"type": "object",
"required": [
"encoded"
],
"properties": {
"encoded": {
"type": "string",
"examples": [
"eyJwYXlsb2FkIjoiLi4uIiwic2lnbmF0dXJlIjoiLi4uIn0="
]
}
}
},
"EncodeAndSignResponse": {
"title": "EncodeAndSignResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EncodeAndSignData"
}
}
},
"DecodeAndVerifyRequest": {
"title": "DecodeAndVerifyRequest",
"type": "object",
"required": [
"encoded"
],
"properties": {
"encoded": {
"type": "string",
"examples": [
"eyJwYXlsb2FkIjoiLi4uIiwic2lnbmF0dXJlIjoiLi4uIn0="
]
}
}
},
"DecodeAndVerifyData": {
"title": "DecodeAndVerifyData",
"type": "object",
"required": [
"decoded",
"encodedByUserId",
"isVerifiedUser"
],
"properties": {
"decoded": {
"description": "The original object that was encoded."
},
"encodedByUserId": {
"type": [
"string",
"null"
],
"examples": [
"wRwJZtadYvn4mBZmm"
]
},
"isVerifiedUser": {
"type": "boolean",
"examples": [
false
]
}
}
},
"DecodeAndVerifyResponse": {
"title": "DecodeAndVerifyResponse",
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/DecodeAndVerifyData"
}
}
}
},
"responses": {
"BadRequest": {
"description": "Bad request - invalid input parameters or request body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "invalid-input",
"message": "Invalid input: The request body contains invalid data."
}
}
}
}
},
"Unauthorized": {
"description": "Unauthorized - authentication required or invalid token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "invalid-token",
"message": "Authentication token is not valid."
}
}
}
}
},
"Forbidden": {
"description": "Forbidden - insufficient permissions to perform this action.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "insufficient-permissions",
"message": "You do not have permission to perform this action."
}
}
}
}
},
"MethodNotAllowed": {
"description": "Method not allowed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "method-not-allowed",
"message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
}
}
}
}
},
"TooManyRequests": {
"description": "Too many requests - rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "rate-limit-exceeded",
"message": "You have exceeded the rate limit. Please try again later."
}
}
}
}
},
"PayloadTooLarge": {
"description": "Payload too large - the request body exceeds the size limit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "request-too-large",
"message": "The POST payload is too large (limit: 9437184 bytes, actual length: 10485760 bytes)."
}
}
}
}
},
"UnsupportedMediaType": {
"description": "Unsupported media type - the Content-Encoding of the request is not supported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "unsupported-content-encoding",
"message": "Content-Encoding \"bla\" is not supported."
}
}
}
}
},
"NotFound": {
"description": "Not found - the requested resource does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "record-not-found",
"message": "The requested resource was not found."
}
}
}
}
},
"PaymentRequired": {
"description": "Payment required - the user has exceeded their usage limit, does not have enough credits, or the request lacks authentication and payment credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "x402-payment-required",
"message": "Please provide X402-PAYMENT-SIGNATURE header with the payment. See https://x402.org."
}
}
}
}
},
"Timeout": {
"description": "The HTTP request exceeded the timeout limit",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "run-timeout-exceeded",
"message": "Actor run exceeded the timeout of 300 seconds for this API endpoint"
}
}
}
}
},
"NoContent": {
"description": "No content"
},
"Conflict": {
"description": "Conflict - the request could not be completed due to a conflict with the current state of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"error": {
"type": "actor-name-not-unique",
"message": "Record with the given name already exists."
}
}
}
}
}
},
"examples": {
"ListOfRunsResponseExample": {
"value": {
"data": {
"total": 2,
"offset": 0,
"limit": 1000,
"desc": false,
"count": 2,
"items": [
{
"id": "HG7ML7M8z78YcAPEB",
"actId": "HDSasDasz78YcAPEB",
"actorTaskId": "KJHSKHausidyaJKHs",
"status": "SUCCEEDED",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"buildId": "HG7ML7M8z78YcAPEB",
"buildNumber": "0.0.2",
"meta": {
"origin": "WEB"
},
"usageTotalUsd": 0.2,
"defaultKeyValueStoreId": "sfAjeR4QmeJCQzTfe",
"defaultDatasetId": "3ZojQDdFTsyE7Moy4",
"defaultRequestQueueId": "so93g2shcDzK3pA85"
},
{
"id": "HG7ML7M8z78YcAPEB",
"actId": "HDSasDasz78YcAPEB",
"actorTaskId": "KJHSKHausidyaJKHs",
"status": "FAILED",
"startedAt": "2019-12-12T07:34:14.202Z",
"finishedAt": "2019-12-13T08:36:13.202Z",
"buildId": "u78dML7M8z78YcAPEB",
"buildNumber": "0.2.2",
"meta": {
"origin": "DEVELOPMENT"
},
"usageTotalUsd": 0.6,
"defaultKeyValueStoreId": "sffsouqlseJCQzTfe",
"defaultDatasetId": "CFGggdjQDsyE7Moyw",
"defaultRequestQueueId": "soowucklrmDzKpA8x"
}
]
}
}
}
}
},
"x-tagGroups": [
{
"name": "Actor management",
"tags": [
"Actors",
"Actors/Actor versions",
"Actors/Actor builds",
"Actors/Actor runs",
"Actors/Webhook collection",
"Actors/Last run object and its storages"
]
},
{
"name": "Actor builds",
"tags": [
"Actor builds"
]
},
{
"name": "Actor runs",
"tags": [
"Actor runs"
]
},
{
"name": "Actor tasks",
"tags": [
"Actor tasks"
]
},
{
"name": "Storage",
"tags": [
"Storage/Datasets",
"Storage/Key-value stores",
"Storage/Request queues",
"Storage/Request queues/Requests",
"Storage/Request queues/Requests locks"
]
},
{
"name": "Webhook management",
"tags": [
"Webhooks/Webhooks",
"Webhooks/Webhook dispatches"
]
},
{
"name": "Schedules",
"tags": [
"Schedules"
]
},
{
"name": "Apify Store",
"tags": [
"Store"
]
},
{
"name": "Logs",
"tags": [
"Logs"
]
},
{
"name": "Users",
"tags": [
"Users",
"Users/Usage"
]
},
{
"name": "Utility tools",
"tags": [
"Tools",
"Tools/Encoding"
]
},
{
"name": "Convenience endpoints",
"tags": [
"Default dataset",
"Default key-value store",
"Default request queue",
"Last Actor run's default dataset",
"Last Actor run's default key-value store",
"Last Actor run's default request queue",
"Last Actor run's log",
"Last Actor run's abort",
"Last Actor run's metamorph",
"Last Actor run's reboot",
"Last Actor task run's default dataset",
"Last Actor task run's default key-value store",
"Last Actor task run's default request queue",
"Last Actor task run's log",
"Last Actor task run's abort",
"Last Actor task run's metamorph",
"Last Actor task run's reboot"
]
}
]
}</datasetid></description></label>