{ "components": { "examples": { "ListOfRunsResponseExample": { "value": { "data": { "count": 2, "desc": false, "items": [ { "actId": "HDSasDasz78YcAPEB", "actorTaskId": "KJHSKHausidyaJKHs", "buildId": "HG7ML7M8z78YcAPEB", "buildNumber": "0.0.2", "defaultDatasetId": "3ZojQDdFTsyE7Moy4", "defaultKeyValueStoreId": "sfAjeR4QmeJCQzTfe", "defaultRequestQueueId": "so93g2shcDzK3pA85", "finishedAt": "2019-12-12T09:30:12.202Z", "id": "HG7ML7M8z78YcAPEB", "meta": { "origin": "WEB" }, "startedAt": "2019-11-30T07:34:24.202Z", "status": "SUCCEEDED", "usageTotalUsd": 0.2 }, { "actId": "HDSasDasz78YcAPEB", "actorTaskId": "KJHSKHausidyaJKHs", "buildId": "u78dML7M8z78YcAPEB", "buildNumber": "0.2.2", "defaultDatasetId": "CFGggdjQDsyE7Moyw", "defaultKeyValueStoreId": "sffsouqlseJCQzTfe", "defaultRequestQueueId": "soowucklrmDzKpA8x", "finishedAt": "2019-12-13T08:36:13.202Z", "id": "HG7ML7M8z78YcAPEB", "meta": { "origin": "DEVELOPMENT" }, "startedAt": "2019-12-12T07:34:14.202Z", "status": "FAILED", "usageTotalUsd": 0.6 } ], "limit": 1000, "offset": 0, "total": 2 } } } }, "parameters": { "Content-Encoding": { "description": "", "in": "header", "name": "Content-Encoding", "required": false, "schema": { "enum": [ "gzip", "deflate", "br", "identity" ], "type": "string" }, "style": "simple" }, "actorId": { "description": "Actor ID or a tilde-separated owner's username and Actor name.", "in": "path", "name": "actorId", "required": true, "schema": { "example": "janedoe~my-actor", "type": "string" }, "style": "simple" }, "actorTaskId": { "description": "Task ID or a tilde-separated owner's username and task's name.", "in": "path", "name": "actorTaskId", "required": true, "schema": { "example": "janedoe~my-task", "type": "string" }, "style": "simple" }, "attachment": { "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", "explode": true, "in": "query", "name": "attachment", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "bom": { "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", "explode": true, "in": "query", "name": "bom", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "build": { "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", "explode": true, "in": "query", "name": "build", "schema": { "example": "0.1.234", "type": "string" }, "style": "form" }, "buildId": { "description": "ID of the build, found in the build's Info tab.", "in": "path", "name": "buildId", "required": true, "schema": { "example": "soSkq9ekdmfOslopH", "type": "string" }, "style": "simple" }, "buildIdWithDefault": { "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", "in": "path", "name": "buildId", "required": true, "schema": { "example": "soSkq9ekdmfOslopH", "type": "string" }, "style": "simple" }, "buildOrRunId": { "description": "ID of the Actor build or run.", "in": "path", "name": "buildOrRunId", "required": true, "schema": { "example": "HG7ML7M8z78YcAPE", "type": "string" }, "style": "simple" }, "buildResurrect": { "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", "explode": true, "in": "query", "name": "build", "schema": { "example": "0.1.234", "type": "string" }, "style": "form" }, "clean": { "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", "explode": true, "in": "query", "name": "clean", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "clientKey": { "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", "explode": true, "in": "query", "name": "clientKey", "schema": { "example": "client-abc", "type": "string" }, "style": "form" }, "collectionKeys": { "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.", "in": "query", "name": "collection", "schema": { "example": "postImages", "type": "string" } }, "collectionRecords": { "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", "in": "query", "name": "collection", "schema": { "example": "my-collection", "type": "string" } }, "contentTypeJson": { "description": "", "in": "header", "name": "Content-Type", "required": true, "schema": { "const": "application/json", "type": "string" }, "style": "simple" }, "cursor": { "description": "A cursor string for pagination, returned in the previous response as `nextCursor`. Use this to retrieve the next page of requests.", "explode": true, "in": "query", "name": "cursor", "schema": { "example": "eyJyZXF1ZXN0SWQiOiI2OFRqQ2RaTDNvM2hiUU0ifQ", "type": "string" }, "style": "form" }, "datasetId": { "description": "Dataset ID or `username~dataset-name`.", "in": "path", "name": "datasetId", "required": true, "schema": { "example": "WkzbQMuFYuamGv3YF", "type": "string" }, "style": "simple" }, "datasetParameters_limit": { "description": "Maximum number of items to return. By default there is no limit.", "explode": true, "in": "query", "name": "limit", "schema": { "format": "double", "type": "number" }, "style": "form" }, "deleteForefront": { "description": "Determines if request should be added to the head of the queue or to the\nend after lock was removed.\n", "explode": true, "in": "query", "name": "forefront", "schema": { "example": "false", "type": "string" }, "style": "form" }, "delimiter": { "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", "explode": true, "in": "query", "name": "delimiter", "schema": { "example": ";", "type": "string" }, "style": "form" }, "descCreatedAt": { "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", "explode": true, "in": "query", "name": "desc", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "descDataset": { "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", "explode": true, "in": "query", "name": "desc", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "descStartedAt": { "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", "explode": true, "in": "query", "name": "desc", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "download": { "description": "If `true` or `1` then the web browser will download the log file rather than open it in a tab.\n", "explode": true, "in": "query", "name": "download", "required": false, "schema": { "example": false, "type": "boolean" }, "style": "form" }, "exclusiveStartId": { "deprecated": true, "description": "All requests up to this one (including) are skipped from the result. (Deprecated, use `cursor` instead.)", "explode": true, "in": "query", "name": "exclusiveStartId", "schema": { "example": "Ihnsp8YrvJ8102Kj", "type": "string" }, "style": "form" }, "exclusiveStartKey": { "description": "All keys up to this one (including) are skipped from the result.", "in": "query", "name": "exclusiveStartKey", "schema": { "example": "Ihnsp8YrvJ8102Kj", "type": "string" } }, "feedDescription": { "description": "Overrides the auto-generated RSS channel `` element.\nOnly used when `format=rss`. If not provided, the description defaults to `Items in dataset with id \"\".`\n", "explode": true, "in": "query", "name": "feedDescription", "schema": { "example": "Scraped forum posts", "type": "string" }, "style": "form" }, "feedTitle": { "description": "Overrides the auto-generated RSS channel `` element.\nOnly used when `format=rss`. If not provided, the title defaults to `Dataset <label>`.\n", "explode": true, "in": "query", "name": "feedTitle", "schema": { "example": "Latest posts from r/pasta", "type": "string" }, "style": "form" }, "fields": { "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", "explode": true, "in": "query", "name": "fields", "schema": { "example": "myValue,myOtherValue", "type": "string" }, "style": "form" }, "filter": { "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 \u2013 requests matching any of the specified states will be returned. (Not compatible with deprecated `exclusiveStartId` parameter.)", "explode": false, "in": "query", "name": "filter", "schema": { "example": [ "locked" ], "items": { "enum": [ "locked", "pending" ], "type": "string" }, "type": "array" }, "style": "form" }, "flatten": { "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", "explode": true, "in": "query", "name": "flatten", "schema": { "example": "myValue", "type": "string" }, "style": "form" }, "forefront": { "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", "explode": true, "in": "query", "name": "forefront", "schema": { "example": "false", "type": "string" }, "style": "form" }, "format": { "description": "Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`.\n", "explode": true, "in": "query", "name": "format", "schema": { "example": "json", "type": "string" }, "style": "form" }, "gracefully": { "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", "explode": true, "in": "query", "name": "gracefully", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "headLimit": { "description": "How many items from queue should be returned.", "explode": true, "in": "query", "name": "limit", "schema": { "example": 100, "format": "double", "type": "number" }, "style": "form" }, "headLockLimit": { "description": "How many items from the queue should be returned.", "explode": true, "in": "query", "name": "limit", "schema": { "example": 25, "format": "double", "maximum": 25, "type": "number" }, "style": "form" }, "keyValueStoreParameters_attachment": { "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", "in": "query", "name": "attachment", "required": false, "schema": { "example": true, "type": "boolean" } }, "keyValueStoreParameters_limit": { "description": "Number of keys to be returned.", "in": "query", "name": "limit", "schema": { "default": 1000, "example": 100, "format": "int32", "maximum": 1000, "minimum": 1, "type": "number" } }, "limit": { "description": "Maximum number of items to return. The default value as well as the maximum is `1000`.\n", "explode": true, "in": "query", "name": "limit", "schema": { "example": 1000, "format": "double", "type": "number" }, "style": "form" }, "listLimit": { "description": "Number of keys to be returned. Maximum value is `10000`.", "explode": true, "in": "query", "name": "limit", "schema": { "example": 100, "format": "double", "type": "number" }, "style": "form" }, "lockForefront": { "description": "Determines if request should be added to the head of the queue or to the\nend after lock expires.\n", "explode": true, "in": "query", "name": "forefront", "schema": { "example": "false", "type": "string" }, "style": "form" }, "lockSecs": { "description": "How long the requests will be locked for (in seconds).", "explode": true, "in": "query", "name": "lockSecs", "required": true, "schema": { "example": 60, "format": "double", "type": "number" }, "style": "form" }, "maxItems": { "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", "explode": true, "in": "query", "name": "maxItems", "required": false, "schema": { "example": 1000, "format": "double", "type": "number" }, "style": "form" }, "maxTotalChargeUsd": { "description": "Specifies the maximum cost of the run. This parameter is\nuseful for pay-per-event Actors, as it allows you to limit the amount\ncharged to your subscription. You can access the maximum cost in your Actor\nby using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.\n", "explode": true, "in": "query", "name": "maxTotalChargeUsd", "required": false, "schema": { "example": 5, "format": "double", "type": "number" }, "style": "form" }, "memory": { "description": "Memory limit for the run, in megabytes. The amount of memory can be set to a power of 2 with a minimum of 128.\nBy default, the run uses the memory limit from its configuration.\n", "explode": true, "in": "query", "name": "memory", "schema": { "example": 256, "format": "double", "type": "number" }, "style": "form" }, "memoryResurrect": { "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", "explode": true, "in": "query", "name": "memory", "schema": { "example": 256, "format": "double", "type": "number" }, "style": "form" }, "offset": { "description": "Number of items that should be skipped at the start. The default value is `0`.\n", "explode": true, "in": "query", "name": "offset", "schema": { "example": 0, "format": "double", "type": "number" }, "style": "form" }, "omit": { "description": "A comma-separated list of fields which should be omitted from the items.", "explode": true, "in": "query", "name": "omit", "schema": { "example": "myValue,myOtherValue", "type": "string" }, "style": "form" }, "outputFields": { "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", "explode": true, "in": "query", "name": "outputFields", "schema": { "example": "title,link", "type": "string" }, "style": "form" }, "outputRecordKey": { "description": "Key of the record from run's default key-value store to be returned\nin the response. By default, it is `OUTPUT`.\n", "explode": true, "in": "query", "name": "outputRecordKey", "schema": { "example": "OUTPUT", "type": "string" }, "style": "form" }, "prefixKeys": { "description": "Limit the results to keys that start with a specific prefix.", "in": "query", "name": "prefix", "schema": { "example": "post-images-", "type": "string" } }, "prefixRecords": { "description": "If specified, only records whose key starts with the given prefix are included in the archive.\n", "in": "query", "name": "prefix", "schema": { "example": "my-prefix/", "type": "string" } }, "queueId": { "description": "Queue ID or `username~queue-name`.", "in": "path", "name": "queueId", "required": true, "schema": { "example": "WkzbQMuFYuamGv3YF", "type": "string" }, "style": "simple" }, "raw": { "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", "explode": true, "in": "query", "name": "raw", "required": false, "schema": { "example": false, "type": "boolean" }, "style": "form" }, "recordKey": { "description": "Key of the record.", "in": "path", "name": "recordKey", "required": true, "schema": { "example": "someKey", "type": "string" }, "style": "simple" }, "requestId": { "description": "Request ID.", "in": "path", "name": "requestId", "required": true, "schema": { "example": "xpsmkDlspokDSmklS", "type": "string" }, "style": "simple" }, "restartOnError": { "description": "Determines whether the run will be restarted if it fails.\n", "explode": true, "in": "query", "name": "restartOnError", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "restartOnErrorResurrect": { "description": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.\n", "explode": true, "in": "query", "name": "restartOnError", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "runId": { "description": "Actor run ID.", "in": "path", "name": "runId", "required": true, "schema": { "example": "3KH8gEpp4d8uQSe8T", "type": "string" }, "style": "simple" }, "scheduleId": { "description": "Schedule ID.", "in": "path", "name": "scheduleId", "required": true, "schema": { "example": "asdLZtadYvn4mBZmm", "type": "string" }, "style": "simple" }, "signature": { "description": "Signature used for the access.", "in": "query", "name": "signature", "required": false, "schema": { "example": "2wTI46Bg8qWQrV7tavlPI", "type": "string" }, "style": "form" }, "simplified": { "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", "explode": true, "in": "query", "name": "simplified", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "skipEmpty": { "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", "explode": true, "in": "query", "name": "skipEmpty", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "skipFailedPages": { "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", "explode": true, "in": "query", "name": "skipFailedPages", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "skipHeaderRow": { "description": "If `true` or `1` then header row in the `csv` format is skipped.", "explode": true, "in": "query", "name": "skipHeaderRow", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "skipHidden": { "description": "If `true` or `1` then hidden fields are skipped from the output, i.e. fields starting with the `#` character.\n", "explode": true, "in": "query", "name": "skipHidden", "schema": { "example": false, "type": "boolean" }, "style": "form" }, "startedAfter": { "allowReserved": true, "description": "Filter runs that started after the specified date and time (inclusive).\nThe value must be a valid ISO 8601 datetime string (UTC).\n", "explode": true, "in": "query", "name": "startedAfter", "schema": { "example": "2025-09-01T00:00:00.000Z", "format": "date-time", "type": "string" }, "style": "form" }, "startedBefore": { "allowReserved": true, "description": "Filter runs that started before the specified date and time (inclusive).\nThe value must be a valid ISO 8601 datetime string (UTC).\n", "explode": true, "in": "query", "name": "startedBefore", "schema": { "example": "2025-09-17T23:59:59.000Z", "format": "date-time", "type": "string" }, "style": "form" }, "status": { "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", "explode": false, "in": "query", "name": "status", "schema": { "example": [ "SUCCEEDED" ], "items": { "type": "string" }, "type": "array" }, "style": "form" }, "statusLastRun": { "description": "Filter for the run status.", "explode": true, "in": "query", "name": "status", "schema": { "example": "SUCCEEDED", "type": "string" }, "style": "form" }, "storeId": { "description": "Key-value store ID or `username~store-name`.", "in": "path", "name": "storeId", "required": true, "schema": { "example": "WkzbQMuFYuamGv3YF", "type": "string" }, "style": "simple" }, "stream": { "description": "If `true` or `1` then the logs will be streamed as long as the run or build is running.\n", "explode": true, "in": "query", "name": "stream", "required": false, "schema": { "example": false, "type": "boolean" }, "style": "form" }, "targetActorId": { "description": "ID of a target Actor that the run should be transformed into.", "explode": true, "in": "query", "name": "targetActorId", "required": true, "schema": { "example": "HDSasDasz78YcAPEB", "type": "string" }, "style": "form" }, "timeout": { "description": "Optional timeout for the run, in seconds. By default, the run uses the timeout from its configuration.\n", "explode": true, "in": "query", "name": "timeout", "schema": { "example": 60, "format": "double", "type": "number" }, "style": "form" }, "timeoutResurrect": { "description": "Optional timeout for the run, in seconds. By default, the run uses the timeout\nspecified in the run that is being resurrected.\n", "explode": true, "in": "query", "name": "timeout", "schema": { "example": 60, "format": "double", "type": "number" }, "style": "form" }, "unnamed": { "description": "If `true` or `1` then all the storages are returned. By default, only\nnamed storages are returned.\n", "explode": true, "in": "query", "name": "unnamed", "schema": { "example": true, "type": "boolean" }, "style": "form" }, "unwind": { "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", "explode": true, "in": "query", "name": "unwind", "schema": { "example": "myValue,myOtherValue", "type": "string" }, "style": "form" }, "versionNumber": { "description": "Actor version.", "in": "path", "name": "versionNumber", "required": true, "schema": { "example": "0.1", "type": "string" }, "style": "simple" }, "view": { "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](/platform/actors/development/actor-definition/dataset-schema).\n", "in": "query", "name": "view", "schema": { "example": "overview", "type": "string" } }, "waitForFinishBuild": { "description": "The maximum number of seconds the server waits for the build to finish.\nBy default it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->\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", "explode": true, "in": "query", "name": "waitForFinish", "schema": { "example": 60, "format": "double", "type": "number" }, "style": "form" }, "waitForFinishRun": { "description": "The maximum number of seconds the server waits for the run to finish. By\ndefault it is `0`, the maximum value is `60`. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS -->\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", "explode": true, "in": "query", "name": "waitForFinish", "schema": { "example": 60, "format": "double", "type": "number" }, "style": "form" }, "webhookId": { "description": "Webhook ID.", "in": "path", "name": "webhookId", "required": true, "schema": { "example": "pVJtoTelgYUq4qJOt", "type": "string" }, "style": "simple" }, "webhooks": { "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", "explode": true, "in": "query", "name": "webhooks", "schema": { "contentEncoding": "base64", "contentMediaType": "application/json", "contentSchema": { "items": { "$ref": "#/components/schemas/WebhookRepresentation" }, "type": "array" }, "example": "dGhpcyBpcyBqdXN0IGV4YW1wbGUK...", "type": "string" }, "style": "form" }, "xmlRoot": { "description": "Overrides default root element name of `xml` output. By default the root element is `items`.\n", "explode": true, "in": "query", "name": "xmlRoot", "schema": { "example": "items", "type": "string" }, "style": "form" }, "xmlRow": { "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", "explode": true, "in": "query", "name": "xmlRow", "schema": { "example": "item", "type": "string" }, "style": "form" } }, "responses": { "BadRequest": { "content": { "application/json": { "example": { "error": { "message": "Invalid input: The request body contains invalid data.", "type": "invalid-input" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - invalid input parameters or request body." }, "Conflict": { "content": { "application/json": { "example": { "error": { "message": "Record with the given name already exists.", "type": "actor-name-not-unique" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Conflict - the request could not be completed due to a conflict with the current state of the resource." }, "Forbidden": { "content": { "application/json": { "example": { "error": { "message": "You do not have permission to perform this action.", "type": "insufficient-permissions" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - insufficient permissions to perform this action." }, "MethodNotAllowed": { "content": { "application/json": { "example": { "error": { "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET", "type": "method-not-allowed" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Method not allowed." }, "NoContent": { "description": "No content" }, "NotFound": { "content": { "application/json": { "example": { "error": { "message": "The requested resource was not found.", "type": "record-not-found" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not found - the requested resource does not exist." }, "PayloadTooLarge": { "content": { "application/json": { "example": { "error": { "message": "The POST payload is too large (limit: 9437184 bytes, actual length: 10485760 bytes).", "type": "request-too-large" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Payload too large - the request body exceeds the size limit." }, "PaymentRequired": { "content": { "application/json": { "example": { "error": { "message": "Please provide X402-PAYMENT-SIGNATURE header with the payment. See https://x402.org.", "type": "x402-payment-required" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Payment required - the user has exceeded their usage limit, does not have enough credits, or the request lacks authentication and payment credentials." }, "RunTimeout": { "content": { "application/json": { "example": { "error": { "message": "Actor run exceeded the timeout of 300 seconds for this API endpoint", "type": "run-timeout-exceeded" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The HTTP request exceeded the timeout limit" }, "TooManyRequests": { "content": { "application/json": { "example": { "error": { "message": "You have exceeded the rate limit. Please try again later.", "type": "rate-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - rate limit exceeded." }, "Unauthorized": { "content": { "application/json": { "example": { "error": { "message": "Authentication token is not valid.", "type": "invalid-token" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - authentication required or invalid token." }, "UnsupportedMediaType": { "content": { "application/json": { "example": { "error": { "message": "Content-Encoding \"bla\" is not supported.", "type": "unsupported-content-encoding" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unsupported media type - the Content-Encoding of the request is not supported." } }, "schemas": { "AccountLimits": { "properties": { "current": { "$ref": "#/components/schemas/Current" }, "limits": { "$ref": "#/components/schemas/Limits" }, "monthlyUsageCycle": { "$ref": "#/components/schemas/UsageCycle" } }, "required": [ "monthlyUsageCycle", "limits", "current" ], "title": "AccountLimits", "type": "object" }, "Actor": { "properties": { "actorPermissionLevel": { "$ref": "#/components/schemas/ActorPermissionLevel" }, "actorStandby": { "anyOf": [ { "$ref": "#/components/schemas/ActorStandby" }, { "type": "null" } ] }, "categories": { "examples": [ [ "DEVELOPER_TOOLS", "OPEN_SOURCE" ] ], "items": { "type": "string" }, "type": "array" }, "createdAt": { "examples": [ "2019-07-08T11:27:57.401Z" ], "format": "date-time", "type": "string" }, "defaultRunOptions": { "$ref": "#/components/schemas/DefaultRunOptions" }, "deploymentKey": { "examples": [ "ssh-rsa AAAA ..." ], "type": "string" }, "description": { "examples": [ "My favourite actor!" ], "type": [ "string", "null" ] }, "exampleRunInput": { "anyOf": [ { "$ref": "#/components/schemas/ExampleRunInput" }, { "type": "null" } ] }, "hasNoDataset": { "examples": [ false ], "type": "boolean" }, "id": { "examples": [ "zdc3Pyhyz3m8vjDeM" ], "type": "string" }, "isCritical": { "examples": [ false ], "type": "boolean" }, "isDeprecated": { "examples": [ false ], "type": [ "boolean", "null" ] }, "isGeneric": { "examples": [ false ], "type": "boolean" }, "isPublic": { "examples": [ false ], "type": "boolean" }, "isSourceCodeHidden": { "examples": [ false ], "type": "boolean" }, "modifiedAt": { "examples": [ "2019-07-08T14:01:05.546Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "MyActor" ], "type": "string" }, "notice": { "examples": [ "NONE" ], "type": "string" }, "pictureUrl": { "examples": [ "https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png" ], "type": [ "string", "null" ] }, "pricingInfos": { "items": { "$ref": "#/components/schemas/ActorRunPricingInfo" }, "type": "array" }, "readmeSummary": { "description": "A brief, LLM-generated readme summary", "type": "string" }, "restartOnError": { "deprecated": true, "examples": [ false ], "type": "boolean" }, "seoDescription": { "examples": [ "Crawls websites using Chrome and extracts data from pages using JavaScript." ], "type": [ "string", "null" ] }, "seoTitle": { "examples": [ "Web Scraper" ], "type": [ "string", "null" ] }, "standbyUrl": { "examples": [ "https://my-actor.apify.actor" ], "type": [ "string", "null" ] }, "stats": { "$ref": "#/components/schemas/ActorStats" }, "taggedBuilds": { "anyOf": [ { "$ref": "#/components/schemas/TaggedBuilds" }, { "type": "null" } ] }, "title": { "examples": [ "My Actor" ], "type": [ "string", "null" ] }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" }, "username": { "examples": [ "jane35" ], "type": "string" }, "versions": { "description": "", "items": { "$ref": "#/components/schemas/Version" }, "type": "array" } }, "required": [ "id", "userId", "name", "username", "isPublic", "createdAt", "modifiedAt", "stats", "versions", "defaultRunOptions" ], "title": "Actor", "type": "object" }, "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", "properties": { "eventDescription": { "description": "Human-readable description of what triggers this event.", "type": "string" }, "eventPriceUsd": { "description": "Flat price per event in USD. Present only for non-tiered events. Mutually exclusive with `eventTieredPricingUsd`.\n", "type": "number" }, "eventTieredPricingUsd": { "$ref": "#/components/schemas/TieredPricingPerEvent" }, "eventTitle": { "description": "Human-readable title shown to users in the billing UI.", "type": "string" }, "isOneTimeEvent": { "description": "Whether this event can only be charged once per Actor run.", "type": "boolean" }, "isPrimaryEvent": { "description": "Whether this event is the Actor's primary chargeable event.", "type": "boolean" } }, "required": [ "eventTitle", "eventDescription" ], "title": "ActorChargeEvent", "type": "object" }, "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)", "properties": { "actorSpecification": { "const": 1, "description": "The Actor specification version that this Actor follows. This property must be set to 1.", "type": "integer" }, "buildTag": { "description": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified.", "type": "string" }, "changelog": { "description": "The path to the CHANGELOG file displayed in the Actor's information tab.", "type": "string" }, "defaultMemoryMbytes": { "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](/platform/actors/development/actor-definition/dynamic-actor-memory).", "oneOf": [ { "examples": [ "get(input", "startUrls.length", "1) * 1024" ], "type": "string" }, { "examples": [ 1024 ], "type": "integer" } ] }, "dockerContextDir": { "description": "The path to the directory used as the Docker context when building the Actor.", "type": "string" }, "dockerfile": { "description": "The path to the Dockerfile used for building the Actor on the platform.", "type": "string" }, "environmentVariables": { "additionalProperties": { "type": "string" }, "description": "A map of environment variables to be used during local development and deployment.", "type": "object" }, "input": { "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)", "type": "object" }, "maxMemoryMbytes": { "description": "Specifies the maximum amount of memory in megabytes required by the Actor.", "minimum": 128, "type": "integer" }, "minMemoryMbytes": { "description": "Specifies the minimum amount of memory in megabytes required by the Actor.", "minimum": 128, "type": "integer" }, "name": { "description": "The name of the Actor.", "type": "string" }, "readme": { "description": "The path to the README file for the Actor.", "type": "string" }, "storages": { "properties": { "dataset": { "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)", "type": "object" } }, "type": "object" }, "usesStandbyMode": { "description": "Specifies whether Standby mode is enabled for the Actor.", "type": "boolean" }, "version": { "description": "The version of the Actor, typically a dot-separated sequence of numbers (e.g., `0.1`, `1.0`, or `0.0.1`).", "pattern": "^[0-9]+(\\.[0-9]+)+$", "type": "string" } }, "title": "ActorDefinition", "type": "object" }, "ActorJobStatus": { "description": "Status of an Actor job (run or build).", "enum": [ "READY", "RUNNING", "SUCCEEDED", "FAILED", "TIMING-OUT", "TIMED-OUT", "ABORTING", "ABORTED" ], "title": "ActorJobStatus", "type": "string" }, "ActorPermissionLevel": { "description": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions).\n", "enum": [ "LIMITED_PERMISSIONS", "FULL_PERMISSIONS" ], "examples": [ "LIMITED_PERMISSIONS" ], "type": "string" }, "ActorResponse": { "description": "Response containing Actor data.", "properties": { "data": { "$ref": "#/components/schemas/Actor" } }, "required": [ "data" ], "title": "ActorResponse", "type": "object" }, "ActorRunFailedError": { "example": { "error": { "message": "Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)", "type": "run-failed" } }, "properties": { "error": { "$ref": "#/components/schemas/RunFailedErrorDetail" } }, "type": "object" }, "ActorRunPricingInfo": { "discriminator": { "mapping": { "FLAT_PRICE_PER_MONTH": "#/components/schemas/FlatPricePerMonthActorPricingInfo", "FREE": "#/components/schemas/FreeActorPricingInfo", "PAY_PER_EVENT": "#/components/schemas/PayPerEventActorPricingInfo", "PRICE_PER_DATASET_ITEM": "#/components/schemas/PricePerDatasetItemActorPricingInfo" }, "propertyName": "pricingModel" }, "oneOf": [ { "$ref": "#/components/schemas/PayPerEventActorPricingInfo" }, { "$ref": "#/components/schemas/PricePerDatasetItemActorPricingInfo" }, { "$ref": "#/components/schemas/FlatPricePerMonthActorPricingInfo" }, { "$ref": "#/components/schemas/FreeActorPricingInfo" } ], "title": "ActorRunPricingInfo" }, "ActorRunTimeoutExceededError": { "example": { "error": { "message": "Actor run exceeded the timeout of 300 seconds for this API endpoint", "type": "run-timeout-exceeded" } }, "properties": { "error": { "$ref": "#/components/schemas/RunTimeoutExceededErrorDetail" } }, "type": "object" }, "ActorShort": { "properties": { "createdAt": { "examples": [ "2019-10-29T07:34:24.202Z" ], "format": "date-time", "type": "string" }, "id": { "examples": [ "br9CKmk457" ], "type": "string" }, "modifiedAt": { "examples": [ "2019-10-30T07:34:24.202Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "MyAct" ], "type": "string" }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/ActorStats" }, { "type": "null" } ] }, "title": { "examples": [ "Hello World Example" ], "type": "string" }, "username": { "examples": [ "janedoe" ], "type": "string" } }, "required": [ "id", "createdAt", "modifiedAt", "name", "username" ], "title": "ActorShort", "type": "object" }, "ActorStandby": { "properties": { "build": { "type": [ "string", "null" ] }, "desiredRequestsPerActorRun": { "type": [ "integer", "null" ] }, "disableStandbyFieldsOverride": { "type": [ "boolean", "null" ] }, "idleTimeoutSecs": { "type": [ "integer", "null" ] }, "isEnabled": { "type": [ "boolean", "null" ] }, "maxRequestsPerActorRun": { "type": [ "integer", "null" ] }, "memoryMbytes": { "type": [ "integer", "null" ] }, "shouldPassActorInput": { "type": [ "boolean", "null" ] } }, "title": "ActorStandby", "type": "object" }, "ActorStats": { "properties": { "actorReviewCount": { "examples": [ 69 ], "type": "integer" }, "actorReviewRating": { "examples": [ 4.7 ], "type": "number" }, "bookmarkCount": { "examples": [ 1269 ], "type": "integer" }, "lastRunStartedAt": { "examples": [ "2019-07-08T14:01:05.546Z" ], "format": "date-time", "type": "string" }, "publicActorRunStats30Days": { "description": "Run status counts over the past 30 days.", "properties": { "ABORTED": { "examples": [ 2542 ], "type": "integer" }, "FAILED": { "examples": [ 1234 ], "type": "integer" }, "SUCCEEDED": { "examples": [ 732805 ], "type": "integer" }, "TIMED-OUT": { "examples": [ 12556 ], "type": "integer" }, "TOTAL": { "examples": [ 749137 ], "type": "integer" } }, "type": "object" }, "totalBuilds": { "examples": [ 9 ], "type": "integer" }, "totalMetamorphs": { "examples": [ 2 ], "type": "integer" }, "totalRuns": { "examples": [ 16 ], "type": "integer" }, "totalUsers": { "examples": [ 6 ], "type": "integer" }, "totalUsers30Days": { "examples": [ 6 ], "type": "integer" }, "totalUsers7Days": { "examples": [ 2 ], "type": "integer" }, "totalUsers90Days": { "examples": [ 6 ], "type": "integer" } }, "title": "ActorStats", "type": "object" }, "AddRequestResponse": { "description": "Response containing the result of adding a request to the request queue.", "properties": { "data": { "$ref": "#/components/schemas/RequestRegistration" } }, "required": [ "data" ], "title": "AddRequestResponse", "type": "object" }, "AddedRequest": { "description": "Information about a request that was successfully added to a request queue.", "properties": { "requestId": { "$ref": "#/components/schemas/RequestId" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" }, "wasAlreadyHandled": { "$ref": "#/components/schemas/WasAlreadyHandled" }, "wasAlreadyPresent": { "$ref": "#/components/schemas/WasAlreadyPresent" } }, "required": [ "requestId", "uniqueKey", "wasAlreadyHandled", "wasAlreadyPresent" ], "title": "AddedRequest", "type": "object" }, "AvailableProxyGroups": { "additionalProperties": { "description": "The number of available proxies in this group.", "type": "integer" }, "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", "example": { "DATACENTER": 500, "GOOGLE_SERP": 200, "RESIDENTIAL": 1000 }, "title": "AvailableProxyGroups", "type": "object" }, "BatchAddResponse": { "description": "Response containing the result of a batch add operation.", "example": { "data": { "processedRequests": [ { "requestId": "YiKoxjkaS9gjGTqhF", "uniqueKey": "http://example.com", "wasAlreadyHandled": false, "wasAlreadyPresent": true } ], "unprocessedRequests": [ { "method": "GET", "uniqueKey": "http://example.com/2", "url": "http://example.com/2" } ] } }, "properties": { "data": { "$ref": "#/components/schemas/BatchAddResult" } }, "required": [ "data" ], "title": "BatchAddResponse", "type": "object" }, "BatchAddResult": { "description": "Result of a batch add operation containing successfully processed and failed requests.", "properties": { "processedRequests": { "description": "Requests that were successfully added to the request queue.", "items": { "$ref": "#/components/schemas/AddedRequest" }, "type": "array" }, "unprocessedRequests": { "description": "Requests that failed to be added and can be retried.", "items": { "$ref": "#/components/schemas/RequestDraft" }, "type": "array" } }, "required": [ "processedRequests", "unprocessedRequests" ], "title": "BatchAddResult", "type": "object" }, "BatchDeleteResponse": { "description": "Response containing the result of a batch delete operation.", "properties": { "data": { "$ref": "#/components/schemas/BatchDeleteResult" } }, "required": [ "data" ], "title": "BatchDeleteResponse", "type": "object" }, "BatchDeleteResult": { "description": "Result of a batch delete operation containing successfully deleted and failed requests.", "properties": { "processedRequests": { "description": "Requests that were successfully deleted from the request queue.", "items": { "$ref": "#/components/schemas/DeletedRequest" }, "type": "array" }, "unprocessedRequests": { "description": "Requests that failed to be deleted and can be retried.", "items": { "$ref": "#/components/schemas/RequestDraft" }, "type": "array" } }, "required": [ "processedRequests", "unprocessedRequests" ], "title": "BatchDeleteResult", "type": "object" }, "BrowserInfoResponse": { "properties": { "bodyLength": { "description": "Length of the request body in bytes.", "example": 0, "type": "integer" }, "clientIp": { "description": "IP address of the client.", "example": "1.2.3.4", "type": [ "string", "null" ] }, "countryCode": { "description": "Two-letter country code resolved from the client IP address.", "example": "US", "type": [ "string", "null" ] }, "headers": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "Request headers. Omitted when `skipHeaders=true`.\n", "type": "object" }, "method": { "description": "HTTP method of the request.", "example": "GET", "type": "string" }, "rawHeaders": { "description": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`.\n", "items": { "type": "string" }, "type": "array" } }, "required": [ "method", "clientIp", "countryCode", "bodyLength" ], "type": "object" }, "Build": { "example": { "actId": "janedoe~my-actor", "actorDefinition": { "actorSpecification": 1, "buildTag": "latest", "environmentVariables": { "DEBUG_MODE": "false" }, "input": { "properties": { "maxTokens": { "description": "The maximum number of tokens to generate.", "type": "integer" }, "prompt": { "description": "The text prompt to generate completions for.", "type": "string" } }, "required": [ "prompt" ], "type": "object" }, "maxMemoryMbytes": 2048, "minMemoryMbytes": 512, "name": "example-actor", "storages": { "dataset": { "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "id": { "description": "Unique identifier for the generated text.", "type": "string" }, "text": { "description": "The generated text output from the model.", "type": "string" } }, "required": [ "id", "text" ], "type": "object" } }, "usesStandbyMode": false, "version": "1.0" }, "buildNumber": "0.1.1", "finishedAt": "2019-12-12T09:30:12.202Z", "id": "HG7ML7M8z78YcAPEB", "inputSchema": "{\\n \"title\": \"Schema for ...\"}", "meta": { "clientIp": "172.234.12.34", "origin": "WEB", "userAgent": "Mozilla/5.0 (iPad)" }, "options": { "betaPackages": false, "diskMbytes": 2048, "memoryMbytes": 1024, "useCache": false }, "readme": "# Magic Actor\\nThis Actor is magic.", "startedAt": "2019-11-30T07:34:24.202Z", "stats": { "computeUnits": 0.012699444444444444, "durationMillis": 1000, "runTimeSecs": 45.718 }, "status": "SUCCEEDED", "usage": { "ACTOR_COMPUTE_UNITS": 0.08 }, "usageTotalUsd": 0.02, "usageUsd": { "ACTOR_COMPUTE_UNITS": 0.02 }, "userId": "klmdEpoiojmdEMlk3" }, "properties": { "actId": { "examples": [ "janedoe~my-actor" ], "type": "string" }, "actVersion": { "description": "Snapshot of the Actor version that this build was created from.", "properties": { "buildTag": { "examples": [ "experimental" ], "type": "string" }, "gitRepoUrl": { "description": "URL of the git repository, present when sourceType is GIT_REPO.", "examples": [ "https://github.com/apifytech/actor-crawler.git#experimental:web-scraper" ], "type": "string" }, "sourceFiles": { "description": "Inline source files, present when sourceType is SOURCE_FILES.", "items": { "$ref": "#/components/schemas/SourceCodeFile" }, "type": "array" }, "sourceType": { "$ref": "#/components/schemas/VersionSourceType" }, "versionNumber": { "examples": [ "0.0" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$", "type": "string" } }, "title": "BuildActVersion", "type": "object" }, "actorDefinition": { "anyOf": [ { "$ref": "#/components/schemas/ActorDefinition" }, { "type": "null" } ] }, "buildNumber": { "examples": [ "0.1.1" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$", "type": "string" }, "finishedAt": { "examples": [ "2019-12-12T09:30:12.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "id": { "examples": [ "HG7ML7M8z78YcAPEB" ], "type": "string" }, "inputSchema": { "deprecated": true, "examples": [ "{\\n \"title\": \"Schema for ... }" ], "type": [ "string", "null" ] }, "meta": { "$ref": "#/components/schemas/BuildsMeta" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/BuildOptions" }, { "type": "null" } ] }, "readme": { "deprecated": true, "examples": [ "# Magic Actor\\nThis Actor is magic." ], "type": [ "string", "null" ] }, "startedAt": { "examples": [ "2019-11-30T07:34:24.202Z" ], "format": "date-time", "type": "string" }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/BuildStats" }, { "type": "null" } ] }, "status": { "$ref": "#/components/schemas/ActorJobStatus" }, "usage": { "anyOf": [ { "$ref": "#/components/schemas/BuildUsage" }, { "type": "null" } ] }, "usageTotalUsd": { "description": "Total cost in USD for this build. Requires authentication token to access.", "examples": [ 0.02 ], "type": [ "number", "null" ] }, "usageUsd": { "anyOf": [ { "$ref": "#/components/schemas/BuildUsage" }, { "type": "null" } ], "description": "Platform usage costs breakdown in USD for this build. Requires authentication token to access." }, "userId": { "examples": [ "klmdEpoiojmdEMlk3" ], "type": "string" } }, "required": [ "id", "actId", "userId", "startedAt", "status", "meta", "buildNumber" ], "title": "Build", "type": "object" }, "BuildOptions": { "properties": { "betaPackages": { "examples": [ false ], "type": [ "boolean", "null" ] }, "diskMbytes": { "examples": [ 2048 ], "type": [ "integer", "null" ] }, "memoryMbytes": { "examples": [ 1024 ], "type": [ "integer", "null" ] }, "useCache": { "examples": [ false ], "type": [ "boolean", "null" ] } }, "title": "BuildOptions", "type": "object" }, "BuildResponse": { "description": "Response containing Actor build data.", "properties": { "data": { "$ref": "#/components/schemas/Build" } }, "required": [ "data" ], "title": "BuildResponse", "type": "object" }, "BuildShort": { "properties": { "actId": { "examples": [ "janedoe~my-actor" ], "type": "string" }, "buildNumber": { "examples": [ "0.1.1" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$", "type": "string" }, "buildNumberInt": { "examples": [ 10000 ], "type": "integer" }, "finishedAt": { "examples": [ "2019-12-12T09:30:12.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "id": { "examples": [ "HG7ML7M8z78YcAPEB" ], "type": "string" }, "meta": { "$ref": "#/components/schemas/BuildsMeta" }, "startedAt": { "examples": [ "2019-11-30T07:34:24.202Z" ], "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/ActorJobStatus" }, "usageTotalUsd": { "examples": [ 0.02 ], "type": "number" }, "userId": { "examples": [ "klmdEpoiojmdEMlk3" ], "type": "string" } }, "required": [ "id", "status", "startedAt", "usageTotalUsd", "buildNumber" ], "title": "BuildShort", "type": "object" }, "BuildStats": { "properties": { "computeUnits": { "examples": [ 0.0126994444444444 ], "type": "number" }, "durationMillis": { "examples": [ 1000 ], "type": "integer" }, "imageSizeBytes": { "examples": [ 975770223 ], "type": "integer" }, "runTimeSecs": { "examples": [ 45.718 ], "type": "number" } }, "required": [ "computeUnits" ], "title": "BuildStats", "type": "object" }, "BuildTag": { "properties": { "buildId": { "type": "string" } }, "required": [ "buildId" ], "title": "BuildTag", "type": [ "object", "null" ] }, "BuildUsage": { "properties": { "ACTOR_COMPUTE_UNITS": { "examples": [ 0.08 ], "type": [ "number", "null" ] } }, "title": "BuildUsage", "type": "object" }, "BuildsMeta": { "properties": { "clientIp": { "description": "IP address of the client that started the build.", "examples": [ "172.234.12.34" ], "type": [ "string" ] }, "origin": { "$ref": "#/components/schemas/RunOrigin" }, "userAgent": { "description": "User agent of the client that started the build.", "examples": [ "Mozilla/5.0 (iPad)" ], "type": [ "string" ] } }, "required": [ "origin" ], "title": "BuildsMeta", "type": "object" }, "ChargeRunRequest": { "properties": { "count": { "examples": [ 1 ], "type": "integer" }, "eventName": { "examples": [ "ANALYZE_PAGE" ], "type": "string" } }, "required": [ "eventName", "count" ], "title": "ChargeRunRequest", "type": "object" }, "CommonActorPricingInfo": { "properties": { "apifyMarginPercentage": { "description": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify", "type": "number" }, "createdAt": { "description": "When this pricing info record has been created", "format": "date-time", "type": "string" }, "forceContainsSignificantPriceChange": { "type": "boolean", "x-internal": true }, "isPriceChangeNotificationSuppressed": { "type": "boolean", "x-internal": true }, "notifiedAboutChangeAt": { "format": "date-time", "type": [ "string", "null" ], "x-internal": true }, "notifiedAboutFutureChangeAt": { "format": "date-time", "type": [ "string", "null" ], "x-internal": true }, "reasonForChange": { "type": [ "string", "null" ], "x-internal": true }, "startedAt": { "description": "Since when is this pricing info record effective for a given Actor", "format": "date-time", "type": "string" } }, "required": [ "apifyMarginPercentage", "createdAt", "startedAt" ], "title": "CommonActorPricingInfo", "type": "object" }, "CreateActorRequest": { "properties": { "actorStandby": { "anyOf": [ { "$ref": "#/components/schemas/ActorStandby" }, { "type": "null" } ] }, "categories": { "description": "", "items": { "type": "string" }, "type": [ "array", "null" ] }, "defaultRunOptions": { "$ref": "#/components/schemas/DefaultRunOptions" }, "description": { "examples": [ "My favourite actor!" ], "type": [ "string", "null" ] }, "exampleRunInput": { "anyOf": [ { "$ref": "#/components/schemas/ExampleRunInput" }, { "type": "null" } ] }, "isDeprecated": { "type": [ "boolean", "null" ] }, "isPublic": { "examples": [ false ], "type": [ "boolean", "null" ] }, "name": { "examples": [ "MyActor" ], "type": [ "string", "null" ] }, "pricingInfos": { "items": { "$ref": "#/components/schemas/ActorRunPricingInfo" }, "type": "array" }, "restartOnError": { "deprecated": true, "examples": [ false ], "type": "boolean" }, "seoDescription": { "examples": [ "My actor is the best" ], "type": [ "string", "null" ] }, "seoTitle": { "examples": [ "My actor" ], "type": [ "string", "null" ] }, "title": { "examples": [ "My actor" ], "type": [ "string", "null" ] }, "versions": { "description": "", "items": { "$ref": "#/components/schemas/Version" }, "type": [ "array", "null" ] } }, "title": "CreateActorRequest", "type": "object" }, "CreateOrUpdateVersionRequest": { "properties": { "applyEnvVarsToBuild": { "examples": [ false ], "type": [ "boolean", "null" ] }, "buildTag": { "examples": [ "latest" ], "type": [ "string", "null" ] }, "envVars": { "description": "", "items": { "$ref": "#/components/schemas/EnvVarRequest" }, "type": [ "array", "null" ] }, "gitHubGistUrl": { "description": "URL of the GitHub Gist when sourceType is GITHUB_GIST.", "type": [ "string", "null" ] }, "gitRepoUrl": { "description": "URL of the Git repository when sourceType is GIT_REPO.", "type": [ "string", "null" ] }, "sourceFiles": { "$ref": "#/components/schemas/VersionSourceFiles" }, "sourceType": { "anyOf": [ { "$ref": "#/components/schemas/VersionSourceType" }, { "type": "null" } ] }, "tarballUrl": { "description": "URL of the tarball when sourceType is TARBALL.", "type": [ "string", "null" ] }, "versionNumber": { "examples": [ "0.0" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$", "type": [ "string", "null" ] } }, "title": "CreateOrUpdateVersionRequest", "type": "object" }, "CreateTaskRequest": { "properties": { "actId": { "examples": [ "asADASadYvn4mBZmm" ], "type": "string" }, "actorStandby": { "anyOf": [ { "$ref": "#/components/schemas/ActorStandby" }, { "type": "null" } ] }, "input": { "anyOf": [ { "$ref": "#/components/schemas/TaskInput" }, { "type": "null" } ] }, "name": { "examples": [ "my-task" ], "type": "string" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/TaskOptions" }, { "type": "null" } ] }, "title": { "type": [ "string", "null" ] } }, "required": [ "actId" ], "title": "CreateTaskRequest", "type": "object" }, "Current": { "properties": { "activeActorJobCount": { "examples": [ 0 ], "type": "integer" }, "actorCount": { "examples": [ 31 ], "type": "integer" }, "actorMemoryGbytes": { "examples": [ 8 ], "type": "number" }, "actorTaskCount": { "examples": [ 130 ], "type": "integer" }, "monthlyActorComputeUnits": { "examples": [ 500.784475 ], "type": "number" }, "monthlyExternalDataTransferGbytes": { "examples": [ 3.00861903931946 ], "type": "number" }, "monthlyProxySerps": { "examples": [ 34 ], "type": "integer" }, "monthlyResidentialProxyGbytes": { "examples": [ 0.4 ], "type": "number" }, "monthlyUsageUsd": { "examples": [ 43 ], "type": "number" }, "scheduleCount": { "examples": [ 77 ], "type": "integer" }, "teamAccountSeatCount": { "examples": [ 5 ], "type": "integer" } }, "required": [ "monthlyUsageUsd", "monthlyActorComputeUnits", "monthlyExternalDataTransferGbytes", "monthlyProxySerps", "monthlyResidentialProxyGbytes", "actorMemoryGbytes", "actorCount", "actorTaskCount", "activeActorJobCount", "teamAccountSeatCount" ], "title": "Current", "type": "object" }, "CurrentPricingInfo": { "properties": { "apifyMarginPercentage": { "examples": [ 0.2 ], "type": "number" }, "createdAt": { "examples": [ "2023-01-01T00:00:00.000Z" ], "format": "date-time", "type": "string" }, "forceContainsSignificantPriceChange": { "examples": [ false ], "type": "boolean" }, "isPPEPlatformUsagePaidByUser": { "examples": [ false ], "type": "boolean" }, "isPriceChangeNotificationSuppressed": { "examples": [ false ], "type": "boolean" }, "minimalMaxTotalChargeUsd": { "examples": [ 0.5 ], "type": [ "number", "null" ] }, "notifiedAboutChangeAt": { "examples": [ null ], "format": "date-time", "type": [ "string", "null" ] }, "notifiedAboutFutureChangeAt": { "examples": [ null ], "format": "date-time", "type": [ "string", "null" ] }, "pricePerUnitUsd": { "examples": [ null ], "type": [ "number", "null" ] }, "pricingModel": { "examples": [ "FREE" ], "type": "string" }, "pricingPerEvent": { "additionalProperties": true, "description": "Per-event pricing configuration for pay-per-event Actors.", "type": [ "object", "null" ] }, "reasonForChange": { "examples": [ null ], "type": [ "string", "null" ] }, "startedAt": { "examples": [ "2023-01-01T00:00:00.000Z" ], "format": "date-time", "type": "string" }, "trialMinutes": { "examples": [ null ], "type": [ "integer", "null" ] }, "unitName": { "examples": [ null ], "type": [ "string", "null" ] } }, "required": [ "pricingModel" ], "title": "CurrentPricingInfo", "type": "object" }, "DailyServiceUsages": { "properties": { "date": { "examples": [ "2022-10-02T00:00:00.000Z" ], "type": "string" }, "serviceUsage": { "$ref": "#/components/schemas/ServiceUsage" }, "totalUsageCreditsUsd": { "examples": [ 0.0474385791970591 ], "type": "number" } }, "required": [ "date", "serviceUsage", "totalUsageCreditsUsd" ], "title": "DailyServiceUsages", "type": "object" }, "Dataset": { "properties": { "accessedAt": { "examples": [ "2019-12-14T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "actId": { "type": [ "string", "null" ] }, "actRunId": { "type": [ "string", "null" ] }, "cleanItemCount": { "examples": [ 5 ], "minimum": 0, "type": "integer" }, "consoleUrl": { "examples": [ "https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC" ], "format": "uri", "type": "string" }, "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "fields": { "description": "", "items": { "type": "string" }, "type": [ "array", "null" ] }, "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "id": { "examples": [ "WkzbQMuFYuamGv3YF" ], "type": "string" }, "itemCount": { "examples": [ 7 ], "minimum": 0, "type": "integer" }, "itemsPublicUrl": { "description": "A public link to access the dataset items directly.", "examples": [ "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123" ], "format": "uri", "type": "string" }, "modifiedAt": { "examples": [ "2019-12-13T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "d7b9MDYsbtX5L7XAj" ], "type": [ "string", "null" ] }, "schema": { "description": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)", "example": { "actorSpecification": 1, "title": "My dataset", "views": { "overview": { "display": { "component": "table", "properties": { "linkUrl": { "format": "link", "label": "Link URL" } } }, "title": "Overview", "transformation": { "fields": [ "linkUrl" ] } } } }, "type": [ "object", "null" ] }, "stats": { "$ref": "#/components/schemas/DatasetStats" }, "urlSigningSecretKey": { "description": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset.", "type": [ "string", "null" ] }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" } }, "required": [ "id", "userId", "createdAt", "modifiedAt", "accessedAt", "itemCount", "cleanItemCount", "consoleUrl" ], "title": "Dataset", "type": "object" }, "DatasetFieldStatistics": { "properties": { "emptyCount": { "description": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty.", "type": [ "integer", "null" ] }, "max": { "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.", "type": [ "number", "null" ] }, "min": { "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.", "type": [ "number", "null" ] }, "nullCount": { "description": "How many items in the dataset have a null value for this field.", "type": [ "integer", "null" ] } }, "title": "DatasetFieldStatistics", "type": "object" }, "DatasetListItem": { "properties": { "accessedAt": { "examples": [ "2019-12-14T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "actId": { "examples": [ "zdc3Pyhyz3m8vjDeM" ], "type": [ "string", "null" ] }, "actRunId": { "examples": [ "HG7ML7M8z78YcAPEB" ], "type": [ "string", "null" ] }, "cleanItemCount": { "examples": [ 5 ], "type": "integer" }, "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "id": { "examples": [ "WkzbQMuFYuamGv3YF" ], "type": "string" }, "itemCount": { "examples": [ 7 ], "type": "integer" }, "modifiedAt": { "examples": [ "2019-12-13T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "d7b9MDYsbtX5L7XAj" ], "type": "string" }, "stats": { "$ref": "#/components/schemas/DatasetStats" }, "title": { "examples": [ "My Dataset" ], "type": [ "string", "null" ] }, "userId": { "examples": [ "tbXmWu7GCxnyYtSiL" ], "type": "string" }, "username": { "examples": [ "janedoe" ], "type": "string" } }, "required": [ "id", "name", "userId", "createdAt", "modifiedAt", "accessedAt", "itemCount", "cleanItemCount" ], "title": "DatasetListItem", "type": "object" }, "DatasetResponse": { "description": "Response containing dataset metadata.", "properties": { "data": { "$ref": "#/components/schemas/Dataset" } }, "required": [ "data" ], "title": "DatasetResponse", "type": "object" }, "DatasetSchemaValidationError": { "properties": { "data": { "$ref": "#/components/schemas/SchemaValidationErrorData" }, "message": { "description": "A human-readable message describing the error.", "examples": [ "Schema validation failed" ], "type": "string" }, "type": { "description": "The type of the error.", "examples": [ "schema-validation-error" ], "type": "string" } }, "title": "DatasetSchemaValidationError", "type": "object" }, "DatasetStatistics": { "example": { "fieldStatistics": { "name": { "nullCount": 122 }, "price": { "max": 89, "min": 59 } } }, "properties": { "fieldStatistics": { "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/></br>See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information.", "type": [ "object", "null" ] } }, "title": "DatasetStatistics", "type": "object" }, "DatasetStatisticsResponse": { "properties": { "data": { "$ref": "#/components/schemas/DatasetStatistics" } }, "required": [ "data" ], "title": "DatasetStatisticsResponse", "type": "object" }, "DatasetStats": { "properties": { "inflatedBytes": { "description": "Uncompressed size in bytes. Only returned by the dataset list endpoint.", "examples": [ 0 ], "type": "integer" }, "readCount": { "examples": [ 22 ], "type": "integer" }, "storageBytes": { "description": "Total storage size in bytes. Only returned by the single-dataset endpoint.", "examples": [ 783 ], "type": "integer" }, "writeCount": { "examples": [ 3 ], "type": "integer" } }, "title": "DatasetStats", "type": "object" }, "DecodeAndVerifyData": { "properties": { "decoded": { "description": "The original object that was encoded." }, "encodedByUserId": { "examples": [ "wRwJZtadYvn4mBZmm" ], "type": [ "string", "null" ] }, "isVerifiedUser": { "examples": [ false ], "type": "boolean" } }, "required": [ "decoded", "encodedByUserId", "isVerifiedUser" ], "title": "DecodeAndVerifyData", "type": "object" }, "DecodeAndVerifyRequest": { "properties": { "encoded": { "examples": [ "eyJwYXlsb2FkIjoiLi4uIiwic2lnbmF0dXJlIjoiLi4uIn0=" ], "type": "string" } }, "required": [ "encoded" ], "title": "DecodeAndVerifyRequest", "type": "object" }, "DecodeAndVerifyResponse": { "properties": { "data": { "$ref": "#/components/schemas/DecodeAndVerifyData" } }, "required": [ "data" ], "title": "DecodeAndVerifyResponse", "type": "object" }, "DefaultRunOptions": { "properties": { "build": { "examples": [ "latest" ], "type": "string" }, "forcePermissionLevel": { "anyOf": [ { "$ref": "#/components/schemas/ActorPermissionLevel" }, { "type": "null" } ] }, "maxItems": { "type": [ "integer", "null" ] }, "memoryMbytes": { "examples": [ 2048 ], "type": "integer" }, "restartOnError": { "examples": [ false ], "type": "boolean" }, "timeoutSecs": { "examples": [ 3600 ], "type": "integer" } }, "title": "DefaultRunOptions", "type": "object" }, "DeletedRequest": { "anyOf": [ { "$ref": "#/components/schemas/DeletedRequestById" }, { "$ref": "#/components/schemas/DeletedRequestByUniqueKey" } ], "description": "Confirmation of a request that was successfully deleted from a request queue.", "title": "DeletedRequest" }, "DeletedRequestById": { "description": "Confirmation of a request that was successfully deleted, identified by its ID.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" } }, "required": [ "id" ], "title": "DeletedRequestById", "type": "object" }, "DeletedRequestByUniqueKey": { "description": "Confirmation of a request that was successfully deleted, identified by its unique key.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" } }, "required": [ "uniqueKey" ], "title": "DeletedRequestByUniqueKey", "type": "object" }, "EffectivePlatformFeature": { "properties": { "disabledReason": { "examples": [ "The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com" ], "type": [ "string", "null" ] }, "disabledReasonType": { "examples": [ "DISABLED" ], "type": [ "string", "null" ] }, "isEnabled": { "examples": [ true ], "type": "boolean" }, "isTrial": { "examples": [ false ], "type": "boolean" }, "trialExpirationAt": { "examples": [ "2025-01-01T14:00:00.000Z" ], "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "isEnabled", "disabledReason", "disabledReasonType", "isTrial", "trialExpirationAt" ], "title": "EffectivePlatformFeature", "type": "object" }, "EffectivePlatformFeatures": { "properties": { "ACTORS": { "$ref": "#/components/schemas/EffectivePlatformFeature" }, "ACTORS_PUBLIC_ALL": { "$ref": "#/components/schemas/EffectivePlatformFeature" }, "ACTORS_PUBLIC_DEVELOPER": { "$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" }, "SCHEDULER": { "$ref": "#/components/schemas/EffectivePlatformFeature" }, "STORAGE": { "$ref": "#/components/schemas/EffectivePlatformFeature" }, "WEBHOOKS": { "$ref": "#/components/schemas/EffectivePlatformFeature" } }, "required": [ "ACTORS", "STORAGE", "SCHEDULER", "PROXY", "PROXY_EXTERNAL_ACCESS", "PROXY_RESIDENTIAL", "PROXY_SERPS", "WEBHOOKS", "ACTORS_PUBLIC_ALL", "ACTORS_PUBLIC_DEVELOPER" ], "title": "EffectivePlatformFeatures", "type": "object" }, "EncodeAndSignData": { "properties": { "encoded": { "examples": [ "eyJwYXlsb2FkIjoiLi4uIiwic2lnbmF0dXJlIjoiLi4uIn0=" ], "type": "string" } }, "required": [ "encoded" ], "title": "EncodeAndSignData", "type": "object" }, "EncodeAndSignResponse": { "properties": { "data": { "$ref": "#/components/schemas/EncodeAndSignData" } }, "required": [ "data" ], "title": "EncodeAndSignResponse", "type": "object" }, "EnvVar": { "properties": { "isSecret": { "examples": [ false ], "type": [ "boolean", "null" ] }, "name": { "examples": [ "MY_ENV_VAR" ], "type": "string" }, "value": { "description": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API.", "examples": [ "my-value" ], "type": "string" } }, "required": [ "name" ], "title": "EnvVar", "type": "object" }, "EnvVarRequest": { "allOf": [ { "$ref": "#/components/schemas/EnvVar" }, { "required": [ "value" ] } ], "title": "EnvVarRequest" }, "EnvVarResponse": { "properties": { "data": { "$ref": "#/components/schemas/EnvVar" } }, "required": [ "data" ], "title": "EnvVarResponse", "type": "object" }, "ErrorDetail": { "properties": { "message": { "description": "Human-readable error message describing what went wrong.", "type": "string" }, "type": { "$ref": "#/components/schemas/ErrorType" } }, "title": "ErrorDetail", "type": "object" }, "ErrorResponse": { "properties": { "error": { "$ref": "#/components/schemas/ErrorDetail" } }, "required": [ "error" ], "title": "ErrorResponse", "type": "object" }, "ErrorType": { "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-override-paid-actor-trial", "cannot-permanently-delete-subscription", "cannot-publish-actor", "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-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", "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" ], "title": "ErrorType", "type": "string" }, "ExampleRunInput": { "properties": { "body": { "example": "{ \"helloWorld\": 123 }", "type": "string" }, "contentType": { "examples": [ "application/json; charset=utf-8" ], "type": "string" } }, "title": "ExampleRunInput", "type": "object" }, "ExampleWebhookDispatch": { "properties": { "finishedAt": { "examples": [ "2019-12-13T08:36:13.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "removedAt": { "examples": [ null ], "format": "date-time", "type": [ "string", "null" ] }, "status": { "$ref": "#/components/schemas/WebhookDispatchStatus" } }, "required": [ "status" ], "title": "ExampleWebhookDispatch", "type": "object" }, "FlatPricePerMonthActorPricingInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonActorPricingInfo" }, { "properties": { "pricePerUnitUsd": { "description": "Monthly flat price in USD", "type": "number" }, "pricingModel": { "const": "FLAT_PRICE_PER_MONTH", "type": "string" }, "trialMinutes": { "description": "For how long this Actor can be used for free in trial period", "type": "integer" } }, "required": [ "pricingModel", "pricePerUnitUsd", "trialMinutes" ], "type": "object" } ], "title": "FlatPricePerMonthActorPricingInfo" }, "FreeActorPricingInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonActorPricingInfo" }, { "properties": { "pricingModel": { "const": "FREE", "type": "string" } }, "required": [ "pricingModel" ], "type": "object" } ], "title": "FreeActorPricingInfo" }, "GeneralAccess": { "description": "Defines the general access level for the resource.", "enum": [ "ANYONE_WITH_ID_CAN_READ", "ANYONE_WITH_NAME_CAN_READ", "FOLLOW_USER_SETTING", "RESTRICTED" ], "examples": [ "RESTRICTED" ], "title": "GeneralAccess", "type": "string" }, "HadMultipleClients": { "description": "Whether the request queue has been accessed by multiple different clients.", "examples": [ true ], "type": "boolean" }, "HandledRequestCount": { "description": "The number of requests that have been handled.", "examples": [ 100 ], "minimum": 0, "type": "integer" }, "HeadAndLockResponse": { "description": "Response containing locked requests from the request queue head.", "example": { "data": { "hadMultipleClients": true, "items": [ { "id": "8OamqXBCpPHxyj9", "lockExpiresAt": "2022-06-14T23:00:00.000Z", "method": "GET", "retryCount": 0, "uniqueKey": "http://example.com", "url": "http://example.com" }, { "id": "8OamqXBCpPHxyx9", "lockExpiresAt": "2022-06-14T23:00:00.000Z", "method": "GET", "retryCount": 0, "uniqueKey": "http://example.com/a", "url": "http://example.com/a" }, { "id": "8OamqXBCpPHxy08", "lockExpiresAt": "2022-06-14T23:00:00.000Z", "method": "GET", "retryCount": 0, "uniqueKey": "http://example.com/a/b", "url": "http://example.com/a/b" } ], "limit": 3, "lockSecs": 60, "queueModifiedAt": "2018-03-14T23:00:00.000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/LockedRequestQueueHead" } }, "required": [ "data" ], "title": "HeadAndLockResponse", "type": "object" }, "HeadLimit": { "description": "The maximum number of requests returned.", "examples": [ 1000 ], "type": "integer" }, "HeadRequest": { "description": "A request from the request queue head without lock information.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "method": { "$ref": "#/components/schemas/HttpMethod" }, "retryCount": { "$ref": "#/components/schemas/RetryCount" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" }, "url": { "$ref": "#/components/schemas/RequestUrl" } }, "required": [ "id", "uniqueKey", "url" ], "title": "HeadRequest", "type": "object" }, "HeadResponse": { "description": "Response containing requests from the request queue head without locking.", "example": { "data": { "hadMultipleClients": false, "items": [ { "id": "8OamqXBCpPHxyH9", "method": "GET", "retryCount": 0, "uniqueKey": "http://example.com", "url": "http://example.com" }, { "id": "ZJAoqlRijenMQIn", "method": "GET", "retryCount": 0, "uniqueKey": "http://example.com/a/b", "url": "http://example.com/a/b" }, { "id": "hAhkwyk5oOBHKQC", "method": "GET", "retryCount": 1, "uniqueKey": "http://example.com/c/d", "url": "http://example.com/c/d" } ], "limit": 1000, "queueModifiedAt": "2018-03-14T23:00:00.000Z" } }, "properties": { "data": { "$ref": "#/components/schemas/RequestQueueHead" } }, "required": [ "data" ], "title": "HeadResponse", "type": "object" }, "HttpMethod": { "enum": [ "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH" ], "examples": [ "GET" ], "type": "string" }, "InvalidItem": { "properties": { "itemPosition": { "description": "The position of the invalid item in the array.", "examples": [ 2 ], "type": "integer" }, "validationErrors": { "description": "A complete list of AJV validation error objects for the invalid item.", "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array" } }, "title": "InvalidItem", "type": "object" }, "KeyValueStore": { "properties": { "accessedAt": { "examples": [ "2019-12-14T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "actId": { "examples": [ null ], "type": [ "string", "null" ] }, "actRunId": { "examples": [ null ], "type": [ "string", "null" ] }, "consoleUrl": { "examples": [ "https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC" ], "format": "uri", "type": "string" }, "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "id": { "examples": [ "WkzbQMuFYuamGv3YF" ], "type": "string" }, "keysPublicUrl": { "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" ], "format": "uri", "type": "string" }, "modifiedAt": { "examples": [ "2019-12-13T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "d7b9MDYsbtX5L7XAj" ], "type": [ "string", "null" ] }, "recordsPublicUrl": { "description": "A public link to access records of the key-value store directly.", "examples": [ "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records" ], "format": "uri", "type": "string" }, "schema": { "description": "Optional JSON schema describing the keys stored in the key-value store.", "type": [ "object", "null" ] }, "stats": { "$ref": "#/components/schemas/KeyValueStoreStats" }, "urlSigningSecretKey": { "description": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store.", "type": [ "string", "null" ] }, "userId": { "examples": [ "BPWDBd7Z9c746JAnF" ], "type": [ "string", "null" ] }, "username": { "examples": [ "janedoe" ], "type": [ "string", "null" ] } }, "required": [ "id", "createdAt", "modifiedAt", "accessedAt" ], "title": "KeyValueStore", "type": "object" }, "KeyValueStoreKey": { "properties": { "key": { "examples": [ "second-key" ], "type": "string" }, "recordPublicUrl": { "description": "A public link to access this record directly.", "examples": [ "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123" ], "format": "uri", "type": "string" }, "size": { "examples": [ 36 ], "type": "integer" } }, "required": [ "key", "size", "recordPublicUrl" ], "title": "KeyValueStoreKey", "type": "object" }, "KeyValueStoreResponse": { "description": "Response containing key-value store data.", "properties": { "data": { "$ref": "#/components/schemas/KeyValueStore" } }, "required": [ "data" ], "title": "KeyValueStoreResponse", "type": "object" }, "KeyValueStoreStats": { "properties": { "deleteCount": { "examples": [ 6 ], "type": "integer" }, "listCount": { "examples": [ 2 ], "type": "integer" }, "readCount": { "examples": [ 9 ], "type": "integer" }, "s3StorageBytes": { "examples": [ 18 ], "type": "integer" }, "storageBytes": { "examples": [ 457225 ], "type": "integer" }, "writeCount": { "examples": [ 3 ], "type": "integer" } }, "required": [ "readCount", "writeCount", "deleteCount", "listCount" ], "title": "KeyValueStoreStats", "type": "object" }, "Limits": { "properties": { "dataRetentionDays": { "examples": [ 90 ], "type": "integer" }, "maxActorCount": { "examples": [ 100 ], "type": "integer" }, "maxActorMemoryGbytes": { "examples": [ 16 ], "type": "number" }, "maxActorTaskCount": { "examples": [ 1000 ], "type": "integer" }, "maxConcurrentActorJobs": { "examples": [ 256 ], "type": "integer" }, "maxMonthlyActorComputeUnits": { "examples": [ 1000 ], "type": "number" }, "maxMonthlyExternalDataTransferGbytes": { "examples": [ 7 ], "type": "number" }, "maxMonthlyProxySerps": { "examples": [ 50 ], "type": "integer" }, "maxMonthlyResidentialProxyGbytes": { "examples": [ 0.5 ], "type": "number" }, "maxMonthlyUsageUsd": { "examples": [ 300 ], "type": "number" }, "maxScheduleCount": { "examples": [ 100 ], "type": "integer" }, "maxTeamAccountSeatCount": { "examples": [ 9 ], "type": "integer" } }, "required": [ "maxMonthlyUsageUsd", "maxMonthlyActorComputeUnits", "maxMonthlyExternalDataTransferGbytes", "maxMonthlyProxySerps", "maxMonthlyResidentialProxyGbytes", "maxActorMemoryGbytes", "maxActorCount", "maxActorTaskCount", "maxConcurrentActorJobs", "maxTeamAccountSeatCount", "dataRetentionDays" ], "title": "Limits", "type": "object" }, "LimitsResponse": { "properties": { "data": { "$ref": "#/components/schemas/AccountLimits" } }, "required": [ "data" ], "title": "LimitsResponse", "type": "object" }, "ListOfActors": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/ActorShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfActors" }, "ListOfActorsInStoreResponse": { "example": { "data": { "count": 1, "desc": false, "items": [ { "currentPricingInfo": { "pricingModel": "FREE" }, "description": "My public Actor!", "id": "zdc3Pyhyz3m8vjDeM", "isWhiteListedForAgenticPayments": true, "name": "my-public-actor", "pictureUrl": "https://...", "stats": { "lastRunStartedAt": "2019-07-08T14:01:05.546Z", "totalBuilds": 9, "totalMetamorphs": 2, "totalRuns": 16, "totalUsers": 6, "totalUsers30Days": 6, "totalUsers7Days": 2, "totalUsers90Days": 6 }, "title": "My Public Actor", "url": "https://...", "userFullName": "Jane Doe", "userPictureUrl": "https://...", "username": "jane35" }, { "categories": [ "MARKETING", "LEAD_GENERATION" ], "currentPricingInfo": { "pricingModel": "FREE" }, "description": "My public Actor!", "id": "zdc3Pyhyz3m8vjDeM", "isWhiteListedForAgenticPayments": false, "name": "my-public-actor", "pictureUrl": "https://...", "stats": { "lastRunStartedAt": "2019-07-08T14:01:05.546Z", "totalBuilds": 9, "totalMetamorphs": 2, "totalRuns": 16, "totalUsers": 6, "totalUsers30Days": 6, "totalUsers7Days": 2, "totalUsers90Days": 6 }, "title": "My Public Actor", "url": "https://...", "userFullName": "Jane H. Doe", "userPictureUrl": "https://...", "username": "jane35" } ], "limit": 1000, "offset": 0, "total": 100 } }, "properties": { "data": { "$ref": "#/components/schemas/ListOfStoreActors" } }, "required": [ "data" ], "title": "ListOfActorsInStoreResponse", "type": "object" }, "ListOfActorsResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfActors" } }, "required": [ "data" ], "title": "ListOfActorsResponse", "type": "object" }, "ListOfBuilds": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/BuildShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfBuilds" }, "ListOfBuildsResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfBuilds" } }, "required": [ "data" ], "title": "ListOfBuildsResponse", "type": "object" }, "ListOfDatasets": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/DatasetListItem" }, "type": "array" }, "unnamed": { "description": "Whether the listing was filtered to only unnamed datasets.", "examples": [ false ], "type": "boolean" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfDatasets" }, "ListOfDatasetsResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfDatasets" } }, "required": [ "data" ], "title": "ListOfDatasetsResponse", "type": "object" }, "ListOfEnvVars": { "properties": { "items": { "description": "", "items": { "$ref": "#/components/schemas/EnvVar" }, "type": "array" }, "total": { "examples": [ 5 ], "type": "integer" } }, "required": [ "total", "items" ], "title": "ListOfEnvVars", "type": "object" }, "ListOfEnvVarsResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfEnvVars" } }, "required": [ "data" ], "title": "ListOfEnvVarsResponse", "type": "object" }, "ListOfKeyValueStores": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/KeyValueStore" }, "type": "array" }, "unnamed": { "description": "Whether the listing was filtered to only unnamed key-value stores.", "examples": [ false ], "type": "boolean" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfKeyValueStores" }, "ListOfKeyValueStoresResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfKeyValueStores" } }, "required": [ "data" ], "title": "ListOfKeyValueStoresResponse", "type": "object" }, "ListOfKeys": { "properties": { "count": { "examples": [ 2 ], "type": "integer" }, "exclusiveStartKey": { "examples": [ "some-key" ], "type": [ "string", "null" ] }, "isTruncated": { "examples": [ true ], "type": "boolean" }, "items": { "description": "", "items": { "$ref": "#/components/schemas/KeyValueStoreKey" }, "type": "array" }, "limit": { "examples": [ 2 ], "type": "integer" }, "nextExclusiveStartKey": { "examples": [ "third-key" ], "type": [ "string", "null" ] } }, "required": [ "items", "count", "limit", "isTruncated" ], "title": "ListOfKeys", "type": "object" }, "ListOfKeysResponse": { "example": { "data": { "count": 2, "exclusiveStartKey": "some-key", "isTruncated": true, "items": [ { "key": "second-key", "recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/second-key?signature=abc123", "size": 36 }, { "key": "third-key", "recordPublicUrl": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/third-key?signature=abc123", "size": 128 } ], "limit": 2, "nextExclusiveStartKey": "third-key" } }, "properties": { "data": { "$ref": "#/components/schemas/ListOfKeys" } }, "required": [ "data" ], "title": "ListOfKeysResponse", "type": "object" }, "ListOfRequestQueues": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "description": "The array of request queues.", "items": { "$ref": "#/components/schemas/RequestQueueShort" }, "type": "array" }, "unnamed": { "description": "Whether the listing was filtered to only unnamed request queues.", "examples": [ false ], "type": "boolean" } }, "required": [ "items" ], "type": "object" } ], "description": "A paginated list of request queues.", "title": "ListOfRequestQueues" }, "ListOfRequestQueuesResponse": { "description": "Response containing a list of request queues.", "properties": { "data": { "$ref": "#/components/schemas/ListOfRequestQueues" } }, "required": [ "data" ], "title": "ListOfRequestQueuesResponse", "type": "object" }, "ListOfRequests": { "description": "A paginated list of requests from the request queue.", "properties": { "cursor": { "description": "A cursor string used for current page of results.", "examples": [ "eyJyZXF1ZXN0SWQiOiI0SVlLUWFXZ2FKUUlWNlMifQ" ], "type": "string" }, "exclusiveStartId": { "deprecated": true, "description": "The ID of the last request from the previous page, used for pagination.", "examples": [ "Ihnsp8YrvJ8102Kj" ], "type": "string" }, "items": { "description": "The array of requests.", "items": { "$ref": "#/components/schemas/Request" }, "type": "array" }, "limit": { "description": "The maximum number of requests returned in this response.", "examples": [ 2 ], "type": "integer" }, "nextCursor": { "description": "A cursor string to be used to continue pagination.", "examples": [ "eyJyZXF1ZXN0SWQiOiI5eFNNc1BrN1J6VUxTNXoifQ" ], "type": "string" } }, "required": [ "items", "limit" ], "title": "ListOfRequests", "type": "object" }, "ListOfRequestsResponse": { "description": "Response containing a list of requests from the request queue.", "example": { "data": { "exclusiveStartId": "Ihnsp8YrvJ8102Kj", "items": [ { "errorMessages": null, "handledAt": "2019-06-16T10:23:31.607Z", "headers": null, "id": "dnjkDMKLmdlkmlkmld", "loadedUrl": "http://example.com/example-1", "method": "GET", "noRetry": false, "payload": null, "retryCount": 0, "uniqueKey": "http://example.com", "url": "http://example.com", "userData": { "image": "https://picserver1.eu", "label": "DETAIL" } }, { "errorMessages": null, "handledAt": "2019-06-16T10:23:31.607Z", "headers": null, "id": "dnjkDMKLmdlkmlkmld", "loadedUrl": "http://example.com/example-1", "method": "GET", "noRetry": false, "payload": null, "retryCount": 0, "uniqueKey": "http://example.com", "url": "http://example.com", "userData": { "image": "https://picserver1.eu", "label": "DETAIL" } } ], "limit": 2 } }, "properties": { "data": { "$ref": "#/components/schemas/ListOfRequests" } }, "required": [ "data" ], "title": "ListOfRequestsResponse", "type": "object" }, "ListOfRuns": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/RunShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfRuns" }, "ListOfRunsResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfRuns" } }, "required": [ "data" ], "title": "ListOfRunsResponse", "type": "object" }, "ListOfSchedules": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/ScheduleShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfSchedules" }, "ListOfSchedulesResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfSchedules" } }, "required": [ "data" ], "title": "ListOfSchedulesResponse", "type": "object" }, "ListOfStoreActors": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/StoreListActor" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfStoreActors" }, "ListOfTasks": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/TaskShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfTasks" }, "ListOfTasksResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfTasks" } }, "required": [ "data" ], "title": "ListOfTasksResponse", "type": "object" }, "ListOfVersions": { "properties": { "items": { "description": "", "items": { "$ref": "#/components/schemas/Version" }, "type": "array" }, "total": { "examples": [ 5 ], "type": "integer" } }, "required": [ "total", "items" ], "title": "ListOfVersions", "type": "object" }, "ListOfVersionsResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfVersions" } }, "required": [ "data" ], "title": "ListOfVersionsResponse", "type": "object" }, "ListOfWebhookDispatches": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/WebhookDispatch" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfWebhookDispatches" }, "ListOfWebhookDispatchesResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfWebhookDispatches" } }, "required": [ "data" ], "title": "ListOfWebhookDispatchesResponse", "type": "object" }, "ListOfWebhooks": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/WebhookShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ], "title": "ListOfWebhooks" }, "ListOfWebhooksResponse": { "properties": { "data": { "$ref": "#/components/schemas/ListOfWebhooks" } }, "required": [ "data" ], "title": "ListOfWebhooksResponse", "type": "object" }, "LockExpiresAt": { "description": "The timestamp when the lock on this request expires.", "examples": [ "2022-06-14T23:00:00.000Z" ], "format": "date-time", "type": "string" }, "LockedHeadRequest": { "description": "A request from the request queue head that has been locked for processing.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "lockExpiresAt": { "$ref": "#/components/schemas/LockExpiresAt" }, "method": { "$ref": "#/components/schemas/HttpMethod" }, "retryCount": { "$ref": "#/components/schemas/RetryCount" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" }, "url": { "$ref": "#/components/schemas/RequestUrl" } }, "required": [ "id", "uniqueKey", "url", "lockExpiresAt" ], "title": "LockedHeadRequest", "type": "object" }, "LockedRequestQueueHead": { "description": "A batch of locked requests from the request queue head.", "properties": { "clientKey": { "description": "The client key used for locking the requests.", "examples": [ "client-one" ], "type": "string" }, "hadMultipleClients": { "$ref": "#/components/schemas/HadMultipleClients" }, "items": { "description": "The array of locked requests from the request queue head.", "items": { "$ref": "#/components/schemas/LockedHeadRequest" }, "type": "array" }, "limit": { "$ref": "#/components/schemas/HeadLimit" }, "lockSecs": { "description": "The number of seconds the locks will be held.", "examples": [ 60 ], "type": "integer" }, "queueHasLockedRequests": { "description": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one).", "examples": [ true ], "type": "boolean" }, "queueModifiedAt": { "$ref": "#/components/schemas/QueueModifiedAt" } }, "required": [ "limit", "queueModifiedAt", "hadMultipleClients", "lockSecs", "items" ], "title": "LockedRequestQueueHead", "type": "object" }, "Metamorph": { "description": "Information about a metamorph event that occurred during the run.", "properties": { "actorId": { "description": "ID of the Actor that the run was metamorphed to.", "examples": [ "nspoEjklmnsF2oosD" ], "type": "string" }, "buildId": { "description": "ID of the build used for the metamorphed Actor.", "examples": [ "ME6oKecqy5kXDS4KQ" ], "type": "string" }, "createdAt": { "description": "Time when the metamorph occurred.", "examples": [ "2019-11-30T07:39:24.202Z" ], "format": "date-time", "type": "string" }, "inputKey": { "description": "Key of the input record in the key-value store.", "examples": [ "INPUT-METAMORPH-1" ], "type": [ "string", "null" ] } }, "required": [ "createdAt", "actorId", "buildId" ], "title": "Metamorph", "type": "object" }, "MonthlyServiceUsage": { "additionalProperties": { "$ref": "#/components/schemas/UsageItem" }, "description": "A map of usage item names (e.g., ACTOR_COMPUTE_UNITS) to their usage details.", "title": "MonthlyServiceUsage", "type": "object" }, "MonthlyUsage": { "properties": { "dailyServiceUsages": { "description": "", "items": { "$ref": "#/components/schemas/DailyServiceUsages" }, "type": "array" }, "monthlyServiceUsage": { "$ref": "#/components/schemas/MonthlyServiceUsage" }, "totalUsageCreditsUsdAfterVolumeDiscount": { "examples": [ 0.786143673840067 ], "type": "number" }, "totalUsageCreditsUsdBeforeVolumeDiscount": { "examples": [ 0.786143673840067 ], "type": "number" }, "usageCycle": { "$ref": "#/components/schemas/UsageCycle" } }, "required": [ "usageCycle", "monthlyServiceUsage", "dailyServiceUsages", "totalUsageCreditsUsdBeforeVolumeDiscount", "totalUsageCreditsUsdAfterVolumeDiscount" ], "title": "MonthlyUsage", "type": "object" }, "MonthlyUsageResponse": { "properties": { "data": { "$ref": "#/components/schemas/MonthlyUsage" } }, "required": [ "data" ], "title": "MonthlyUsageResponse", "type": "object" }, "PaginationResponse": { "description": "Common pagination fields for list responses.", "properties": { "count": { "description": "The number of items returned in this response.", "examples": [ 1 ], "minimum": 0, "type": "integer" }, "desc": { "description": "Whether the results are sorted in descending order.", "examples": [ false ], "type": "boolean" }, "limit": { "description": "The maximum number of items returned per page.", "examples": [ 1000 ], "minimum": 1, "type": "integer" }, "offset": { "description": "The starting position for this page of results.", "examples": [ 0 ], "minimum": 0, "type": "integer" }, "total": { "description": "The total number of items available across all pages.", "examples": [ 1 ], "minimum": 0, "type": "integer" } }, "required": [ "total", "offset", "limit", "desc", "count" ], "title": "PaginationResponse", "type": "object" }, "PayPerEventActorPricingInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonActorPricingInfo" }, { "properties": { "minimalMaxTotalChargeUsd": { "type": [ "number", "null" ] }, "pricingModel": { "const": "PAY_PER_EVENT", "type": "string" }, "pricingPerEvent": { "properties": { "actorChargeEvents": { "additionalProperties": { "$ref": "#/components/schemas/ActorChargeEvent" }, "type": "object" } }, "type": "object" } }, "required": [ "pricingModel", "pricingPerEvent" ], "type": "object" } ], "title": "PayPerEventActorPricingInfo" }, "PendingRequestCount": { "description": "The number of requests that are pending and have not been handled yet.", "examples": [ 670 ], "type": "integer" }, "Plan": { "properties": { "apiRateLimitBoosts": { "examples": [ 0 ], "type": "integer" }, "availableAddOns": { "examples": [ [] ], "items": { "type": "string" }, "type": "array" }, "availableProxyGroups": { "$ref": "#/components/schemas/AvailableProxyGroups" }, "dataRetentionDays": { "examples": [ 14 ], "type": "integer" }, "description": { "examples": [ "Cost-effective plan for freelancers, developers and students." ], "type": "string" }, "enabledPlatformFeatures": { "example": [ "ACTORS", "STORAGE", "PROXY_SERPS", "SCHEDULER", "WEBHOOKS" ], "items": { "type": "string" }, "type": "array" }, "id": { "examples": [ "Personal" ], "type": "string" }, "isEnabled": { "examples": [ true ], "type": "boolean" }, "maxActorCount": { "examples": [ 100 ], "type": "integer" }, "maxActorMemoryGbytes": { "examples": [ 32 ], "type": "number" }, "maxActorTaskCount": { "examples": [ 1000 ], "type": "integer" }, "maxConcurrentActorRuns": { "examples": [ 25 ], "type": "integer" }, "maxMonthlyActorComputeUnits": { "examples": [ 1000 ], "type": "number" }, "maxMonthlyExternalDataTransferGbytes": { "examples": [ 1000 ], "type": "number" }, "maxMonthlyProxySerps": { "examples": [ 30000 ], "type": "integer" }, "maxMonthlyResidentialProxyGbytes": { "examples": [ 10 ], "type": "number" }, "maxMonthlyUsageUsd": { "examples": [ 9999 ], "type": "number" }, "maxScheduleCount": { "examples": [ 100 ], "type": "integer" }, "monthlyBasePriceUsd": { "examples": [ 49 ], "type": "number" }, "monthlyUsageCreditsUsd": { "examples": [ 49 ], "type": "number" }, "planPricing": { "additionalProperties": true, "description": "Pricing details for this plan.", "type": "object" }, "supportLevel": { "examples": [ "COMMUNITY" ], "type": "string" }, "teamAccountSeatCount": { "examples": [ 1 ], "type": "integer" }, "tier": { "examples": [ "FREE" ], "type": "string" }, "usageDiscountPercent": { "examples": [ 0 ], "type": "number" } }, "required": [ "id", "description", "isEnabled", "monthlyBasePriceUsd", "monthlyUsageCreditsUsd", "enabledPlatformFeatures", "maxMonthlyUsageUsd", "maxActorMemoryGbytes", "maxMonthlyActorComputeUnits", "maxMonthlyResidentialProxyGbytes", "maxMonthlyProxySerps", "maxMonthlyExternalDataTransferGbytes", "maxActorCount", "maxActorTaskCount", "dataRetentionDays", "availableProxyGroups", "teamAccountSeatCount", "supportLevel", "availableAddOns" ], "title": "Plan", "type": "object" }, "PricePerDatasetItemActorPricingInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonActorPricingInfo" }, { "properties": { "pricePerUnitUsd": { "description": "Price per unit in USD. Mutually exclusive with `tieredPricing` - exactly one of the two is present\non a pricing record.\n", "type": "number" }, "pricingModel": { "const": "PRICE_PER_DATASET_ITEM", "type": "string" }, "tieredPricing": { "$ref": "#/components/schemas/TieredPricingPerDatasetItem" }, "unitName": { "description": "Name of the unit that is being charged", "type": "string" } }, "required": [ "pricingModel", "unitName" ], "type": "object" } ], "title": "PricePerDatasetItemActorPricingInfo" }, "PriceTiers": { "properties": { "discountPercent": { "examples": [ 100 ], "type": "number" }, "priceUsd": { "examples": [ 0 ], "type": "number" }, "quantityAbove": { "examples": [ 0 ], "type": "number" }, "tierQuantity": { "examples": [ 0.39 ], "type": "number" }, "unitPriceUsd": { "examples": [ 0 ], "type": "number" } }, "required": [ "quantityAbove", "discountPercent", "tierQuantity", "unitPriceUsd", "priceUsd" ], "title": "PriceTiers", "type": "object" }, "PrivateUserDataResponse": { "properties": { "data": { "$ref": "#/components/schemas/UserPrivateInfo" } }, "required": [ "data" ], "title": "PrivateUserDataResponse", "type": "object" }, "Profile": { "properties": { "bio": { "examples": [ "I started web scraping in 1985 using Altair BASIC." ], "type": "string" }, "githubUsername": { "examples": [ "torvalds." ], "type": "string" }, "name": { "examples": [ "Jane Doe" ], "type": "string" }, "pictureUrl": { "examples": [ "https://apify.com/img/anonymous_user_picture.png" ], "format": "uri", "type": "string" }, "twitterUsername": { "examples": [ "@BillGates" ], "type": "string" }, "websiteUrl": { "examples": [ "http://www.example.com" ], "format": "uri", "type": "string" } }, "title": "Profile", "type": "object" }, "ProlongRequestLockResponse": { "description": "Response containing updated lock information after prolonging a request lock.", "properties": { "data": { "$ref": "#/components/schemas/RequestLockInfo" } }, "required": [ "data" ], "title": "ProlongRequestLockResponse", "type": "object" }, "Proxy": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/ProxyGroup" }, "type": "array" }, "password": { "examples": [ "ad78knd9Jkjd86" ], "type": "string" } }, "required": [ "password", "groups" ], "title": "Proxy", "type": "object" }, "ProxyGroup": { "properties": { "availableCount": { "examples": [ 10 ], "type": "integer" }, "description": { "examples": [ "Group1 description" ], "type": [ "string", "null" ] }, "name": { "examples": [ "Group1" ], "type": "string" } }, "required": [ "name", "description", "availableCount" ], "title": "ProxyGroup", "type": "object" }, "PublicUserDataResponse": { "properties": { "data": { "$ref": "#/components/schemas/UserPublicInfo" } }, "required": [ "data" ], "title": "PublicUserDataResponse", "type": "object" }, "PutItemResponseError": { "example": { "error": { "data": { "invalidItems": [ { "itemPosition": 2, "validationErrors": [ { "instancePath": "/1/stringField", "keyword": "type", "message": "must be string", "params": { "type": "string" }, "schemaPath": "/items/properties/stringField/type" } ] } ] }, "message": "Schema validation failed", "type": "schema-validation-error" } }, "properties": { "error": { "$ref": "#/components/schemas/DatasetSchemaValidationError" } }, "required": [ "error" ], "title": "PutItemResponseError", "type": "object" }, "PutItemsRequest": { "additionalProperties": true, "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", "example": { "price": 19.99, "title": "Example Item", "url": "https://example.com" }, "title": "PutItemsRequest", "type": "object" }, "PutRecordRequest": { "additionalProperties": true, "description": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header.\n", "example": { "count": 42, "message": "Hello, world!" }, "title": "PutRecordRequest", "type": "object" }, "QueueAccessedAt": { "description": "The timestamp when the request queue was last accessed.", "examples": [ "2019-12-14T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "QueueCreatedAt": { "description": "The timestamp when the request queue was created.", "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "QueueId": { "description": "A unique identifier assigned to the request queue.", "examples": [ "WkzbQMuFYuamGv3YF" ], "type": "string" }, "QueueModifiedAt": { "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" ], "format": "date-time", "type": "string" }, "QueueUserId": { "description": "The ID of the user who owns the request queue.", "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" }, "RecordResponse": { "additionalProperties": true, "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", "example": { "count": 42, "message": "Hello, world!" }, "title": "RecordResponse", "type": "object" }, "Request": { "allOf": [ { "$ref": "#/components/schemas/RequestBase", "required": [ "id", "uniqueKey", "url" ] }, { "properties": { "id": { "$ref": "#/components/schemas/RequestId" } } } ], "description": "A request stored in the request queue, including its metadata and processing state.", "title": "Request" }, "RequestBase": { "properties": { "errorMessages": { "description": "Error messages recorded from failed processing attempts.", "examples": [ null ], "items": { "type": "string" }, "type": [ "array", "null" ] }, "handledAt": { "description": "The timestamp when the request was marked as handled, if applicable.", "examples": [ "2019-06-16T10:23:31.607Z" ], "format": "date-time", "type": [ "string", "null" ] }, "headers": { "description": "HTTP headers sent with the request.", "examples": [ null ], "type": [ "object", "null" ] }, "loadedUrl": { "description": "The final URL that was loaded, after redirects (if any).", "examples": [ "https://apify.com/jobs" ], "type": [ "string", "null" ] }, "method": { "$ref": "#/components/schemas/HttpMethod" }, "noRetry": { "description": "Indicates whether the request should not be retried if processing fails.", "examples": [ false ], "type": [ "boolean", "null" ] }, "payload": { "description": "The request payload, typically used with POST or PUT requests.", "examples": [ null ], "type": [ "string", "object", "null" ] }, "retryCount": { "$ref": "#/components/schemas/RetryCount" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" }, "url": { "$ref": "#/components/schemas/RequestUrl" }, "userData": { "$ref": "#/components/schemas/RequestUserData" } }, "title": "RequestBase", "type": "object" }, "RequestDraft": { "description": "A request that failed to be processed during a request queue operation and can be retried.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "method": { "$ref": "#/components/schemas/HttpMethod" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" }, "url": { "$ref": "#/components/schemas/RequestUrl" } }, "required": [ "uniqueKey", "url" ], "title": "RequestDraft", "type": "object" }, "RequestDraftDelete": { "anyOf": [ { "$ref": "#/components/schemas/RequestDraftDeleteById" }, { "$ref": "#/components/schemas/RequestDraftDeleteByUniqueKey" } ], "description": "A request that should be deleted.", "title": "RequestDraftDelete" }, "RequestDraftDeleteById": { "description": "A request that should be deleted, identified by its ID.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" } }, "required": [ "id" ], "title": "RequestDraftDeleteById", "type": "object" }, "RequestDraftDeleteByUniqueKey": { "description": "A request that should be deleted, identified by its unique key.", "properties": { "id": { "$ref": "#/components/schemas/RequestId" }, "uniqueKey": { "$ref": "#/components/schemas/UniqueKey" } }, "required": [ "uniqueKey" ], "title": "RequestDraftDeleteByUniqueKey", "type": "object" }, "RequestId": { "description": "A unique identifier assigned to the request.", "examples": [ "sbJ7klsdf7ujN9l" ], "type": "string" }, "RequestLockInfo": { "description": "Information about a request lock.", "properties": { "lockExpiresAt": { "$ref": "#/components/schemas/LockExpiresAt" } }, "required": [ "lockExpiresAt" ], "title": "RequestLockInfo", "type": "object" }, "RequestQueue": { "description": "A request queue object containing metadata and statistics.", "properties": { "accessedAt": { "$ref": "#/components/schemas/QueueAccessedAt" }, "actId": { "description": "The ID of the Actor that created this request queue.", "type": [ "string", "null" ] }, "actRunId": { "description": "The ID of the Actor run that created this request queue.", "type": [ "string", "null" ] }, "consoleUrl": { "description": "The URL to view the request queue in the Apify console.", "examples": [ "https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC" ], "format": "uri", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/QueueCreatedAt" }, "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "hadMultipleClients": { "$ref": "#/components/schemas/HadMultipleClients" }, "handledRequestCount": { "$ref": "#/components/schemas/HandledRequestCount" }, "id": { "$ref": "#/components/schemas/QueueId" }, "modifiedAt": { "$ref": "#/components/schemas/QueueModifiedAt" }, "name": { "description": "The name of the request queue.", "examples": [ "some-name" ], "type": [ "string", "null" ] }, "pendingRequestCount": { "$ref": "#/components/schemas/PendingRequestCount" }, "stats": { "$ref": "#/components/schemas/RequestQueueStats" }, "totalRequestCount": { "$ref": "#/components/schemas/TotalRequestCount" }, "userId": { "$ref": "#/components/schemas/QueueUserId" } }, "required": [ "id", "userId", "createdAt", "modifiedAt", "accessedAt", "totalRequestCount", "handledRequestCount", "pendingRequestCount", "hadMultipleClients", "consoleUrl" ], "title": "RequestQueue", "type": "object" }, "RequestQueueHead": { "description": "A batch of requests from the request queue head without locking.", "properties": { "hadMultipleClients": { "$ref": "#/components/schemas/HadMultipleClients" }, "items": { "description": "The array of requests from the request queue head.", "items": { "$ref": "#/components/schemas/HeadRequest" }, "type": "array" }, "limit": { "$ref": "#/components/schemas/HeadLimit" }, "queueModifiedAt": { "$ref": "#/components/schemas/QueueModifiedAt" } }, "required": [ "limit", "queueModifiedAt", "hadMultipleClients", "items" ], "title": "RequestQueueHead", "type": "object" }, "RequestQueueResponse": { "description": "Response containing request queue data.", "properties": { "data": { "$ref": "#/components/schemas/RequestQueue" } }, "required": [ "data" ], "title": "RequestQueueResponse", "type": "object" }, "RequestQueueShort": { "description": "A shortened request queue object for list responses.", "properties": { "accessedAt": { "$ref": "#/components/schemas/QueueAccessedAt" }, "actId": { "description": "The ID of the Actor that created this request queue.", "type": [ "string", "null" ] }, "actRunId": { "description": "The ID of the Actor run that created this request queue.", "type": [ "string", "null" ] }, "createdAt": { "$ref": "#/components/schemas/QueueCreatedAt" }, "expireAt": { "description": "The timestamp when the request queue will expire and be deleted.", "examples": [ "2019-06-02T17:15:06.751Z" ], "format": "date-time", "type": "string" }, "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "hadMultipleClients": { "$ref": "#/components/schemas/HadMultipleClients" }, "handledRequestCount": { "$ref": "#/components/schemas/HandledRequestCount" }, "id": { "$ref": "#/components/schemas/QueueId" }, "modifiedAt": { "$ref": "#/components/schemas/QueueModifiedAt" }, "name": { "description": "The name of the request queue.", "examples": [ "some-name" ], "type": "string" }, "pendingRequestCount": { "$ref": "#/components/schemas/PendingRequestCount" }, "stats": { "$ref": "#/components/schemas/RequestQueueStats" }, "totalRequestCount": { "$ref": "#/components/schemas/TotalRequestCount" }, "userId": { "$ref": "#/components/schemas/QueueUserId" }, "username": { "description": "The username of the user who owns the request queue.", "examples": [ "janedoe" ], "type": "string" } }, "required": [ "id", "name", "userId", "username", "createdAt", "modifiedAt", "accessedAt", "totalRequestCount", "handledRequestCount", "pendingRequestCount", "hadMultipleClients" ], "title": "RequestQueueShort", "type": "object" }, "RequestQueueStats": { "description": "Statistics about request queue operations and storage.", "properties": { "deleteCount": { "description": "The number of delete operations performed on the request queue.", "examples": [ 0 ], "type": "integer" }, "headItemReadCount": { "description": "The number of times requests from the head were read.", "examples": [ 5 ], "type": "integer" }, "readCount": { "description": "The total number of read operations performed on the request queue.", "examples": [ 100 ], "type": "integer" }, "storageBytes": { "description": "The total storage size in bytes used by the request queue.", "examples": [ 1024 ], "type": "integer" }, "writeCount": { "description": "The total number of write operations performed on the request queue.", "examples": [ 10 ], "type": "integer" } }, "title": "RequestQueueStats", "type": "object" }, "RequestRegistration": { "description": "Result of registering a request in the request queue, either by adding a new request or updating an existing one.", "properties": { "requestId": { "$ref": "#/components/schemas/RequestId" }, "wasAlreadyHandled": { "$ref": "#/components/schemas/WasAlreadyHandled" }, "wasAlreadyPresent": { "$ref": "#/components/schemas/WasAlreadyPresent" } }, "required": [ "requestId", "wasAlreadyPresent", "wasAlreadyHandled" ], "title": "RequestRegistration", "type": "object" }, "RequestResponse": { "description": "Response containing a single request from the request queue.", "properties": { "data": { "$ref": "#/components/schemas/Request" } }, "required": [ "data" ], "title": "RequestResponse", "type": "object" }, "RequestUrl": { "description": "The URL of the request.", "examples": [ "https://apify.com" ], "type": "string" }, "RequestUserData": { "additionalProperties": true, "description": "Custom user data attached to the request. Can contain arbitrary fields.", "example": { "customField": "custom-value", "label": "DETAIL" }, "title": "RequestUserData", "type": "object" }, "RetryCount": { "description": "The number of times this request has been retried.", "examples": [ 0 ], "type": "integer" }, "Run": { "description": "Represents an Actor run and its associated data.", "properties": { "actId": { "description": "ID of the Actor that was run.", "examples": [ "HDSasDasz78YcAPEB" ], "type": "string" }, "actorTaskId": { "description": "ID of the Actor task, if the run was started from a task.", "examples": [ "KJHSKHausidyaJKHs" ], "type": [ "string", "null" ] }, "buildId": { "description": "ID of the Actor build used for this run.", "examples": [ "7sT5jcggjjA9fNcxF" ], "type": "string" }, "buildNumber": { "description": "Build number of the Actor build used for this run.", "examples": [ "0.0.36" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$", "type": [ "string", "null" ] }, "chargedEventCounts": { "additionalProperties": { "type": "integer" }, "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.", "example": { "actor-start": 1, "data-extracted": 75, "page-crawled": 150 }, "type": "object" }, "containerUrl": { "description": "URL of the container running the Actor.", "examples": [ "https://g8kd8kbc5ge8.runs.apify.net" ], "format": "uri", "type": "string" }, "defaultDatasetId": { "description": "ID of the default dataset for this run.", "examples": [ "wmKPijuyDnPZAPRMk" ], "type": "string" }, "defaultKeyValueStoreId": { "description": "ID of the default key-value store for this run.", "examples": [ "eJNzqsbPiopwJcgGQ" ], "type": "string" }, "defaultRequestQueueId": { "description": "ID of the default request queue for this run.", "examples": [ "FL35cSF7jrxr3BY39" ], "type": "string" }, "exitCode": { "description": "Exit code of the Actor run process.", "examples": [ 0 ], "type": [ "integer", "null" ] }, "finishedAt": { "description": "Time when the Actor run finished.", "examples": [ "2019-12-12T09:30:12.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "generalAccess": { "$ref": "#/components/schemas/GeneralAccess", "description": "General access level for the Actor run." }, "gitBranchName": { "description": "Name of the git branch used for the Actor build.", "examples": [ "master" ], "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the Actor run.", "examples": [ "HG7ML7M8z78YcAPEB" ], "type": "string" }, "isContainerServerReady": { "description": "Whether the container's HTTP server is ready to accept requests.", "examples": [ true ], "type": [ "boolean", "null" ] }, "isStatusMessageTerminal": { "description": "Whether the status message is terminal (final).", "examples": [ false ], "type": [ "boolean", "null" ] }, "meta": { "$ref": "#/components/schemas/RunMeta", "description": "Metadata about the Actor run." }, "metamorphs": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Metamorph" }, "type": "array" }, { "type": "null" } ], "description": "List of metamorph events that occurred during the run." }, "options": { "$ref": "#/components/schemas/RunOptions", "description": "Configuration options for the Actor run." }, "platformUsageBillingModel": { "description": "Indicates which party covers platform usage costs for this run.", "examples": [ "USER" ], "type": "string" }, "pricingInfo": { "$ref": "#/components/schemas/ActorRunPricingInfo", "description": "Pricing information for the Actor." }, "startedAt": { "description": "Time when the Actor run started.", "examples": [ "2019-11-30T07:34:24.202Z" ], "format": "date-time", "type": "string" }, "stats": { "$ref": "#/components/schemas/RunStats", "description": "Statistics of the Actor run." }, "status": { "$ref": "#/components/schemas/ActorJobStatus", "description": "Current status of the Actor run." }, "statusMessage": { "description": "Detailed message about the run status.", "examples": [ "Actor is running" ], "type": [ "string", "null" ] }, "storageIds": { "description": "A map of aliased storage IDs associated with this run, grouped by storage type.", "properties": { "datasets": { "additionalProperties": { "type": "string" }, "description": "Aliased dataset IDs for this run.", "properties": { "default": { "description": "ID of the default dataset for this run.", "example": "wmKPijuyDnPZAPRMk", "type": "string" } }, "type": "object" }, "keyValueStores": { "additionalProperties": { "type": "string" }, "description": "Aliased key-value store IDs for this run.", "properties": { "default": { "description": "ID of the default key-value store for this run.", "example": "eJNzqsbPiopwJcgGQ", "type": "string" } }, "type": "object" }, "requestQueues": { "additionalProperties": { "type": "string" }, "description": "Aliased request queue IDs for this run.", "properties": { "default": { "description": "ID of the default request queue for this run.", "example": "FL35cSF7jrxr3BY39", "type": "string" } }, "type": "object" } }, "type": "object" }, "usage": { "anyOf": [ { "$ref": "#/components/schemas/RunUsage" }, { "type": "null" } ], "description": "Resource usage statistics for the run." }, "usageTotalUsd": { "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.", "examples": [ 0.2654 ], "type": [ "number", "null" ] }, "usageUsd": { "anyOf": [ { "$ref": "#/components/schemas/RunUsageUsd" }, { "type": "null" } ], "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." }, "userId": { "description": "ID of the user who started the run.", "examples": [ "7sT5jcggjjA9fNcxF" ], "type": "string" } }, "required": [ "id", "actId", "userId", "startedAt", "status", "meta", "stats", "options", "buildId", "defaultKeyValueStoreId", "defaultDatasetId", "defaultRequestQueueId", "generalAccess" ], "title": "Run", "type": "object" }, "RunFailedErrorDetail": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetail" }, { "properties": { "type": { "const": "run-failed" } }, "type": "object" } ] }, "RunMeta": { "properties": { "clientIp": { "description": "IP address of the client that started the run.", "type": [ "string", "null" ] }, "origin": { "$ref": "#/components/schemas/RunOrigin" }, "scheduleId": { "description": "ID of the schedule that triggered the run.", "type": [ "string", "null" ] }, "scheduledAt": { "description": "Time when the run was scheduled.", "format": "date-time", "type": [ "string", "null" ] }, "userAgent": { "description": "User agent of the client that started the run.", "type": [ "string", "null" ] } }, "required": [ "origin" ], "title": "RunMeta", "type": "object" }, "RunOptions": { "properties": { "build": { "examples": [ "latest" ], "type": "string" }, "diskMbytes": { "examples": [ 2048 ], "minimum": 0, "type": "integer" }, "maxItems": { "examples": [ 1000 ], "minimum": 1, "type": [ "integer", "null" ] }, "maxTotalChargeUsd": { "examples": [ 5 ], "minimum": 0, "type": "number" }, "memoryMbytes": { "examples": [ 1024 ], "maximum": 32768, "minimum": 128, "type": "integer" }, "timeoutSecs": { "examples": [ 300 ], "minimum": 0, "type": "integer" } }, "required": [ "build", "timeoutSecs", "memoryMbytes", "diskMbytes" ], "title": "RunOptions", "type": "object" }, "RunOrigin": { "enum": [ "DEVELOPMENT", "WEB", "API", "SCHEDULER", "TEST", "WEBHOOK", "ACTOR", "CLI", "CI", "STANDBY" ], "title": "RunOrigin", "type": "string" }, "RunResponse": { "properties": { "data": { "$ref": "#/components/schemas/Run" } }, "required": [ "data" ], "title": "RunResponse", "type": "object" }, "RunShort": { "properties": { "actId": { "examples": [ "HDSasDasz78YcAPEB" ], "type": "string" }, "actorTaskId": { "examples": [ "KJHSKHausidyaJKHs" ], "type": [ "string", "null" ] }, "buildId": { "examples": [ "HG7ML7M8z78YcAPEB" ], "type": "string" }, "buildNumber": { "examples": [ "0.0.2" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$", "type": "string" }, "buildNumberInt": { "examples": [ 10000 ], "type": "integer" }, "defaultDatasetId": { "examples": [ "3ZojQDdFTsyE7Moy4" ], "type": "string" }, "defaultKeyValueStoreId": { "examples": [ "sfAjeR4QmeJCQzTfe" ], "type": "string" }, "defaultRequestQueueId": { "examples": [ "so93g2shcDzK3pA85" ], "type": "string" }, "finishedAt": { "examples": [ "2019-12-12T09:30:12.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "id": { "examples": [ "HG7ML7M8z78YcAPEB" ], "type": "string" }, "meta": { "$ref": "#/components/schemas/RunMeta" }, "startedAt": { "examples": [ "2019-11-30T07:34:24.202Z" ], "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/ActorJobStatus" }, "usageTotalUsd": { "examples": [ 0.2 ], "type": "number" }, "userId": { "examples": [ "7sT5jcggjjA9fNcxF" ], "type": "string" } }, "required": [ "id", "actId", "status", "startedAt", "buildId", "meta", "usageTotalUsd", "defaultKeyValueStoreId", "defaultDatasetId", "defaultRequestQueueId" ], "title": "RunShort", "type": "object" }, "RunStats": { "properties": { "computeUnits": { "examples": [ 0.13804 ], "minimum": 0, "type": "number" }, "cpuAvgUsage": { "examples": [ 33.7532101107538 ], "type": "number" }, "cpuCurrentUsage": { "examples": [ 0 ], "type": "number" }, "cpuMaxUsage": { "examples": [ 169.650735534941 ], "type": "number" }, "durationMillis": { "examples": [ 248472 ], "minimum": 0, "type": "integer" }, "inputBodyLen": { "examples": [ 240 ], "minimum": 0, "type": [ "integer", "null" ] }, "memAvgBytes": { "examples": [ 267874071.9 ], "type": "number" }, "memCurrentBytes": { "examples": [ 0 ], "minimum": 0, "type": "integer" }, "memMaxBytes": { "examples": [ 404713472 ], "minimum": 0, "type": "integer" }, "metamorph": { "examples": [ 0 ], "minimum": 0, "type": "integer" }, "migrationCount": { "examples": [ 0 ], "minimum": 0, "type": "integer" }, "netRxBytes": { "examples": [ 103508042 ], "minimum": 0, "type": "integer" }, "netTxBytes": { "examples": [ 4854600 ], "minimum": 0, "type": "integer" }, "rebootCount": { "examples": [ 0 ], "minimum": 0, "type": "integer" }, "restartCount": { "examples": [ 0 ], "minimum": 0, "type": "integer" }, "resurrectCount": { "examples": [ 2 ], "minimum": 0, "type": "integer" }, "runTimeSecs": { "examples": [ 248.472 ], "minimum": 0, "type": "number" } }, "required": [ "restartCount", "resurrectCount", "computeUnits" ], "title": "RunStats", "type": "object" }, "RunTimeoutExceededErrorDetail": { "allOf": [ { "$ref": "#/components/schemas/ErrorDetail" }, { "properties": { "type": { "const": "run-timeout-exceeded" } }, "type": "object" } ] }, "RunUsage": { "properties": { "ACTOR_COMPUTE_UNITS": { "examples": [ 3 ], "type": [ "number", "null" ] }, "DATASET_READS": { "examples": [ 4 ], "type": [ "integer", "null" ] }, "DATASET_WRITES": { "examples": [ 4 ], "type": [ "integer", "null" ] }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "examples": [ 3 ], "type": [ "number", "null" ] }, "DATA_TRANSFER_INTERNAL_GBYTES": { "examples": [ 1 ], "type": [ "number", "null" ] }, "KEY_VALUE_STORE_LISTS": { "examples": [ 5 ], "type": [ "integer", "null" ] }, "KEY_VALUE_STORE_READS": { "examples": [ 5 ], "type": [ "integer", "null" ] }, "KEY_VALUE_STORE_WRITES": { "examples": [ 3 ], "type": [ "integer", "null" ] }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "examples": [ 34 ], "type": [ "number", "null" ] }, "PROXY_SERPS": { "examples": [ 3 ], "type": [ "integer", "null" ] }, "REQUEST_QUEUE_READS": { "examples": [ 2 ], "type": [ "integer", "null" ] }, "REQUEST_QUEUE_WRITES": { "examples": [ 1 ], "type": [ "integer", "null" ] } }, "title": "RunUsage", "type": "object" }, "RunUsageUsd": { "description": "Resource usage costs in USD. All values are monetary amounts in US dollars.", "properties": { "ACTOR_COMPUTE_UNITS": { "examples": [ 0.0003 ], "type": [ "number", "null" ] }, "DATASET_READS": { "examples": [ 0.0001 ], "type": [ "number", "null" ] }, "DATASET_WRITES": { "examples": [ 0.0001 ], "type": [ "number", "null" ] }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "examples": [ 0.003 ], "type": [ "number", "null" ] }, "DATA_TRANSFER_INTERNAL_GBYTES": { "examples": [ 0.001 ], "type": [ "number", "null" ] }, "KEY_VALUE_STORE_LISTS": { "examples": [ 0.0001 ], "type": [ "number", "null" ] }, "KEY_VALUE_STORE_READS": { "examples": [ 0.0001 ], "type": [ "number", "null" ] }, "KEY_VALUE_STORE_WRITES": { "examples": [ 5e-05 ], "type": [ "number", "null" ] }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "examples": [ 0.034 ], "type": [ "number", "null" ] }, "PROXY_SERPS": { "examples": [ 0.003 ], "type": [ "number", "null" ] }, "REQUEST_QUEUE_READS": { "examples": [ 0.0001 ], "type": [ "number", "null" ] }, "REQUEST_QUEUE_WRITES": { "examples": [ 0.0001 ], "type": [ "number", "null" ] } }, "title": "RunUsageUsd", "type": "object" }, "Schedule": { "allOf": [ { "$ref": "#/components/schemas/ScheduleBase" }, { "properties": { "actions": { "description": "", "items": { "$ref": "#/components/schemas/ScheduleAction" }, "type": "array" }, "description": { "examples": [ "Schedule of actor ..." ], "type": [ "string", "null" ] }, "notifications": { "description": "Notification settings for this schedule.", "properties": { "email": { "examples": [ true ], "type": "boolean" } }, "title": "ScheduleNotifications", "type": "object" }, "title": { "type": [ "string", "null" ] } }, "required": [ "actions" ], "type": "object" } ], "title": "Schedule" }, "ScheduleAction": { "discriminator": { "mapping": { "RUN_ACTOR": "#/components/schemas/ScheduleActionRunActor", "RUN_ACTOR_TASK": "#/components/schemas/ScheduleActionRunActorTask" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduleActionRunActor" }, { "$ref": "#/components/schemas/ScheduleActionRunActorTask" } ], "title": "ScheduleAction" }, "ScheduleActionRunActor": { "properties": { "actorId": { "examples": [ "jF8GGEvbEg4Au3NLA" ], "type": "string" }, "id": { "examples": [ "c6KfSgoQzFhMk3etc" ], "type": "string" }, "runInput": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleActionRunInput" }, { "type": "null" } ] }, "runOptions": { "anyOf": [ { "$ref": "#/components/schemas/TaskOptions" }, { "type": "null" } ] }, "type": { "const": "RUN_ACTOR" } }, "required": [ "id", "type", "actorId" ], "title": "ScheduleActionRunActor", "type": "object" }, "ScheduleActionRunActorTask": { "properties": { "actorTaskId": { "examples": [ "jF8GGEvbEg4Au3NLA" ], "type": "string" }, "id": { "examples": [ "c6KfSgoQzFhMk3etc" ], "type": "string" }, "input": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "type": { "const": "RUN_ACTOR_TASK" } }, "required": [ "id", "type", "actorTaskId" ], "title": "ScheduleActionRunActorTask", "type": "object" }, "ScheduleActionRunInput": { "properties": { "body": { "examples": [ "{\\n \"foo\": \"actor\"\\n}" ], "type": [ "string", "null" ] }, "contentType": { "examples": [ "application/json; charset=utf-8" ], "type": [ "string", "null" ] } }, "title": "ScheduleActionRunInput", "type": "object" }, "ScheduleActionShort": { "discriminator": { "mapping": { "RUN_ACTOR": "#/components/schemas/ScheduleActionShortRunActor", "RUN_ACTOR_TASK": "#/components/schemas/ScheduleActionShortRunActorTask" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduleActionShortRunActor" }, { "$ref": "#/components/schemas/ScheduleActionShortRunActorTask" } ], "title": "ScheduleActionShort" }, "ScheduleActionShortRunActor": { "properties": { "actorId": { "examples": [ "HKhKmiCMrDgu9eXeE" ], "type": "string" }, "id": { "examples": [ "ZReCs7hkdieq8ZUki" ], "type": "string" }, "type": { "const": "RUN_ACTOR" } }, "required": [ "id", "type", "actorId" ], "title": "ScheduleActionShortRunActor", "type": "object" }, "ScheduleActionShortRunActorTask": { "properties": { "actorTaskId": { "examples": [ "HKhKmiCMrDgu9eXeE" ], "type": "string" }, "id": { "examples": [ "ZReCs7hkdieq8ZUki" ], "type": "string" }, "type": { "const": "RUN_ACTOR_TASK" } }, "required": [ "id", "type", "actorTaskId" ], "title": "ScheduleActionShortRunActorTask", "type": "object" }, "ScheduleBase": { "properties": { "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "cronExpression": { "examples": [ "* * * * *" ], "type": "string" }, "id": { "examples": [ "asdLZtadYvn4mBZmm" ], "type": "string" }, "isEnabled": { "examples": [ true ], "type": "boolean" }, "isExclusive": { "examples": [ true ], "type": "boolean" }, "lastRunAt": { "examples": [ "2019-04-12T07:33:10.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "modifiedAt": { "examples": [ "2019-12-20T06:33:11.202Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "my-schedule" ], "type": "string" }, "nextRunAt": { "examples": [ "2019-04-12T07:34:10.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "timezone": { "examples": [ "UTC" ], "type": "string" }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" } }, "required": [ "id", "userId", "name", "cronExpression", "timezone", "isEnabled", "isExclusive", "createdAt", "modifiedAt" ], "title": "ScheduleBase", "type": "object" }, "ScheduleCreate": { "properties": { "actions": { "description": "", "items": { "$ref": "#/components/schemas/ScheduleCreateAction" }, "type": [ "array", "null" ] }, "cronExpression": { "examples": [ "* * * * *" ], "type": [ "string", "null" ] }, "description": { "examples": [ "Schedule of actor ..." ], "type": [ "string", "null" ] }, "isEnabled": { "examples": [ true ], "type": [ "boolean", "null" ] }, "isExclusive": { "examples": [ true ], "type": [ "boolean", "null" ] }, "name": { "examples": [ "my-schedule" ], "type": [ "string", "null" ] }, "timezone": { "examples": [ "UTC" ], "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] } }, "title": "ScheduleCreate", "type": "object" }, "ScheduleCreateAction": { "discriminator": { "mapping": { "RUN_ACTOR": "#/components/schemas/ScheduleCreateActionRunActor", "RUN_ACTOR_TASK": "#/components/schemas/ScheduleCreateActionRunActorTask" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ScheduleCreateActionRunActor" }, { "$ref": "#/components/schemas/ScheduleCreateActionRunActorTask" } ], "title": "ScheduleCreateAction" }, "ScheduleCreateActionRunActor": { "properties": { "actorId": { "examples": [ "jF8GGEvbEg4Au3NLA" ], "type": "string" }, "runInput": { "anyOf": [ { "$ref": "#/components/schemas/ScheduleActionRunInput" }, { "type": "null" } ] }, "runOptions": { "anyOf": [ { "$ref": "#/components/schemas/TaskOptions" }, { "type": "null" } ] }, "type": { "const": "RUN_ACTOR" } }, "required": [ "type", "actorId" ], "title": "ScheduleCreateActionRunActor", "type": "object" }, "ScheduleCreateActionRunActorTask": { "properties": { "actorTaskId": { "examples": [ "jF8GGEvbEg4Au3NLA" ], "type": "string" }, "input": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "type": { "const": "RUN_ACTOR_TASK" } }, "required": [ "type", "actorTaskId" ], "title": "ScheduleCreateActionRunActorTask", "type": "object" }, "ScheduleInvoked": { "properties": { "createdAt": { "examples": [ "2019-03-26T12:28:00.370Z" ], "format": "date-time", "type": "string" }, "level": { "examples": [ "INFO" ], "type": "string" }, "message": { "examples": [ "Schedule invoked" ], "type": "string" } }, "required": [ "message", "level", "createdAt" ], "title": "ScheduleInvoked", "type": "object" }, "ScheduleLogResponse": { "properties": { "data": { "description": "", "items": { "$ref": "#/components/schemas/ScheduleInvoked" }, "type": "array" } }, "required": [ "data" ], "title": "ScheduleLogResponse", "type": "object" }, "ScheduleResponse": { "properties": { "data": { "$ref": "#/components/schemas/Schedule" } }, "required": [ "data" ], "title": "ScheduleResponse", "type": "object" }, "ScheduleShort": { "allOf": [ { "$ref": "#/components/schemas/ScheduleBase" }, { "properties": { "actions": { "description": "", "items": { "$ref": "#/components/schemas/ScheduleActionShort" }, "type": "array" } }, "required": [ "actions" ], "type": "object" } ], "title": "ScheduleShort" }, "SchemaValidationErrorData": { "properties": { "invalidItems": { "description": "A list of invalid items in the received array of items.", "items": { "$ref": "#/components/schemas/InvalidItem" }, "type": "array" } }, "required": [ "invalidItems" ], "title": "SchemaValidationErrorData", "type": "object" }, "ServiceUsage": { "additionalProperties": { "$ref": "#/components/schemas/UsageItem" }, "description": "A map of service usage item names to their usage details.", "example": { "ACTOR_COMPUTE_UNITS": { "amountAfterVolumeDiscountUsd": 0.00030000000000000003, "baseAmountUsd": 0.00030000000000000003, "baseUnitPriceUsd": 5e-06, "priceTiers": [], "quantity": 60 } }, "title": "ServiceUsage", "type": "object" }, "SourceCodeFile": { "properties": { "content": { "examples": [ "console.log('This is the main.js file');" ], "type": "string" }, "format": { "$ref": "#/components/schemas/SourceCodeFileFormat" }, "name": { "examples": [ "src/main.js" ], "type": "string" } }, "required": [ "name" ], "title": "SourceCodeFile", "type": "object" }, "SourceCodeFileFormat": { "enum": [ "BASE64", "TEXT" ], "examples": [ "TEXT" ], "type": "string" }, "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", "properties": { "folder": { "description": "Always `true` for folders. Used to distinguish folders from files.", "examples": [ true ], "type": "boolean" }, "name": { "description": "The folder path relative to the Actor's root directory.", "examples": [ "src/utils" ], "type": "string" } }, "required": [ "name", "folder" ], "title": "SourceCodeFolder", "type": "object" }, "StorageOwnership": { "enum": [ "ownedByMe", "sharedWithMe" ], "examples": [ "ownedByMe" ], "type": "string" }, "StoreListActor": { "properties": { "actorReviewCount": { "examples": [ 69 ], "type": "integer" }, "actorReviewRating": { "examples": [ 4.7 ], "type": "number" }, "badge": { "examples": [ null ], "type": [ "string", "null" ] }, "bookmarkCount": { "examples": [ 1269 ], "type": "integer" }, "categories": { "example": [ "MARKETING", "LEAD_GENERATION" ], "items": { "type": "string" }, "type": "array" }, "currentPricingInfo": { "$ref": "#/components/schemas/CurrentPricingInfo" }, "description": { "examples": [ "My public actor!" ], "type": "string" }, "id": { "examples": [ "zdc3Pyhyz3m8vjDeM" ], "type": "string" }, "isWhiteListedForAgenticPayments": { "description": "Whether the Actor is whitelisted for agentic payment processing.", "type": [ "boolean", "null" ] }, "name": { "examples": [ "my-public-actor" ], "type": "string" }, "notice": { "type": "string" }, "pictureUrl": { "examples": [ "https://..." ], "format": "uri", "type": [ "string", "null" ] }, "readmeSummary": { "description": "A brief, LLM-generated readme summary", "type": "string" }, "stats": { "$ref": "#/components/schemas/ActorStats" }, "title": { "examples": [ "My Public Actor" ], "type": "string" }, "url": { "examples": [ "https://..." ], "format": "uri", "type": [ "string", "null" ] }, "userFullName": { "examples": [ "Jane H. Doe" ], "type": "string" }, "userPictureUrl": { "examples": [ "https://..." ], "format": "uri", "type": [ "string", "null" ] }, "username": { "examples": [ "jane35" ], "type": "string" } }, "required": [ "id", "title", "name", "username", "userFullName", "description", "stats", "currentPricingInfo" ], "title": "StoreListActor", "type": "object" }, "TaggedBuildInfo": { "description": "Information about a tagged build.", "properties": { "buildId": { "description": "The ID of the build associated with this tag.", "examples": [ "z2EryhbfhgSyqj6Hn" ], "type": "string" }, "buildNumber": { "description": "The build number/version string.", "examples": [ "0.0.2" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])(\\.[1-9][0-9]{0,4})$", "type": "string" }, "buildNumberInt": { "description": "The build number encoded as a single integer.", "examples": [ 42 ], "type": "integer" }, "finishedAt": { "description": "The timestamp when the build finished.", "examples": [ "2019-06-10T11:15:49.286Z" ], "format": "date-time", "type": [ "string", "null" ] } }, "title": "TaggedBuildInfo", "type": "object" }, "TaggedBuilds": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/TaggedBuildInfo" }, { "type": "null" } ] }, "description": "A dictionary mapping build tag names (e.g., \"latest\", \"beta\") to their build information.", "example": { "beta": { "buildId": "abc123def456", "buildNumber": "1.0.5", "finishedAt": "2019-07-15T14:30:00.000Z" }, "latest": { "buildId": "z2EryhbfhgSyqj6Hn", "buildNumber": "0.0.2", "finishedAt": "2019-06-10T11:15:49.286Z" } }, "title": "TaggedBuilds", "type": "object" }, "Task": { "properties": { "actId": { "examples": [ "asADASadYvn4mBZmm" ], "type": "string" }, "actorStandby": { "anyOf": [ { "$ref": "#/components/schemas/ActorStandby" }, { "type": "null" } ] }, "createdAt": { "examples": [ "2018-10-26T07:23:14.855Z" ], "format": "date-time", "type": "string" }, "id": { "examples": [ "zdc3Pyhyz3m8vjDeM" ], "type": "string" }, "input": { "anyOf": [ { "$ref": "#/components/schemas/TaskInput" }, { "type": "null" } ] }, "modifiedAt": { "examples": [ "2018-10-26T13:30:49.578Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "my-task" ], "type": "string" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/TaskOptions" }, { "type": "null" } ] }, "removedAt": { "format": "date-time", "type": [ "string", "null" ] }, "standbyUrl": { "format": "uri", "type": [ "string", "null" ] }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/TaskStats" }, { "type": "null" } ] }, "title": { "type": [ "string", "null" ] }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" }, "username": { "examples": [ "janedoe" ], "type": [ "string", "null" ] } }, "required": [ "id", "userId", "actId", "name", "createdAt", "modifiedAt" ], "title": "Task", "type": "object" }, "TaskInput": { "additionalProperties": true, "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", "example": { "maxRequestsPerCrawl": 100, "startUrls": [ { "url": "https://example.com" } ] }, "title": "TaskInput", "type": "object" }, "TaskOptions": { "properties": { "build": { "examples": [ "latest" ], "type": [ "string", "null" ] }, "maxItems": { "examples": [ 1000 ], "type": [ "integer", "null" ] }, "maxTotalChargeUsd": { "examples": [ 5 ], "type": [ "number", "null" ] }, "memoryMbytes": { "examples": [ 1024 ], "type": [ "integer", "null" ] }, "restartOnError": { "examples": [ false ], "type": [ "boolean", "null" ] }, "timeoutSecs": { "examples": [ 300 ], "type": [ "integer", "null" ] } }, "title": "TaskOptions", "type": "object" }, "TaskResponse": { "description": "Response containing Actor task data.", "example": { "data": { "actId": "asADASadYvn4mBZmm", "createdAt": "2018-10-26T07:23:14.855Z", "id": "zdc3Pyhyz3m8vjDeM", "input": { "hello": "world" }, "modifiedAt": "2018-10-26T13:30:49.578Z", "name": "my-task", "options": { "build": "latest", "memoryMbytes": 128, "timeoutSecs": 300 }, "removedAt": null, "stats": { "totalRuns": 15 }, "userId": "wRsJZtadYvn4mBZmm", "username": "janedoe" } }, "properties": { "data": { "$ref": "#/components/schemas/Task" } }, "required": [ "data" ], "title": "TaskResponse", "type": "object" }, "TaskShort": { "properties": { "actId": { "examples": [ "asADASadYvn4mBZmm" ], "type": "string" }, "actName": { "examples": [ "my-actor" ], "type": [ "string", "null" ] }, "actUsername": { "examples": [ "janedoe" ], "type": [ "string", "null" ] }, "createdAt": { "examples": [ "2018-10-26T07:23:14.855Z" ], "format": "date-time", "type": "string" }, "id": { "examples": [ "zdc3Pyhyz3m8vjDeM" ], "type": "string" }, "modifiedAt": { "examples": [ "2018-10-26T13:30:49.578Z" ], "format": "date-time", "type": "string" }, "name": { "examples": [ "my-task" ], "type": "string" }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/TaskStats" }, { "type": "null" } ] }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" }, "username": { "examples": [ "janedoe" ], "type": [ "string", "null" ] } }, "required": [ "id", "userId", "actId", "name", "createdAt", "modifiedAt" ], "title": "TaskShort", "type": "object" }, "TaskStats": { "properties": { "totalRuns": { "examples": [ 15 ], "type": "integer" } }, "title": "TaskStats", "type": "object" }, "TestWebhookResponse": { "properties": { "data": { "$ref": "#/components/schemas/WebhookDispatch" } }, "required": [ "data" ], "title": "TestWebhookResponse", "type": "object" }, "TieredPricingPerDatasetItem": { "additionalProperties": { "$ref": "#/components/schemas/TieredPricingPerDatasetItemEntry" }, "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", "title": "TieredPricingPerDatasetItem", "type": "object" }, "TieredPricingPerDatasetItemEntry": { "description": "A single tier's price-per-dataset-item entry.", "properties": { "tieredPricePerUnitUsd": { "description": "Price per unit in USD for this tier.", "type": "number" } }, "required": [ "tieredPricePerUnitUsd" ], "title": "TieredPricingPerDatasetItemEntry", "type": "object" }, "TieredPricingPerEvent": { "additionalProperties": { "$ref": "#/components/schemas/TieredPricingPerEventEntry" }, "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", "title": "TieredPricingPerEvent", "type": "object" }, "TieredPricingPerEventEntry": { "description": "A single tier's price-per-event entry.", "properties": { "tieredEventPriceUsd": { "description": "Price per event in USD for this tier.", "type": "number" } }, "required": [ "tieredEventPriceUsd" ], "title": "TieredPricingPerEventEntry", "type": "object" }, "TotalRequestCount": { "description": "The total number of requests in the request queue.", "examples": [ 870 ], "minimum": 0, "type": "integer" }, "UniqueKey": { "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" ], "type": "string" }, "UnlockRequestsResponse": { "description": "Response containing the result of unlocking requests.", "properties": { "data": { "$ref": "#/components/schemas/UnlockRequestsResult" } }, "required": [ "data" ], "title": "UnlockRequestsResponse", "type": "object" }, "UnlockRequestsResult": { "description": "Result of unlocking requests in the request queue.", "properties": { "unlockedCount": { "description": "Number of requests that were successfully unlocked.", "examples": [ 10 ], "type": "integer" } }, "required": [ "unlockedCount" ], "title": "UnlockRequestsResult", "type": "object" }, "UpdateActorRequest": { "properties": { "actorPermissionLevel": { "anyOf": [ { "$ref": "#/components/schemas/ActorPermissionLevel" }, { "type": "null" } ] }, "actorStandby": { "anyOf": [ { "$ref": "#/components/schemas/ActorStandby" }, { "type": "null" } ] }, "categories": { "description": "", "items": { "type": "string" }, "type": [ "array", "null" ] }, "defaultRunOptions": { "anyOf": [ { "$ref": "#/components/schemas/DefaultRunOptions" }, { "type": "null" } ] }, "description": { "examples": [ "My favourite actor!" ], "type": [ "string", "null" ] }, "exampleRunInput": { "anyOf": [ { "$ref": "#/components/schemas/ExampleRunInput" }, { "type": "null" } ] }, "isDeprecated": { "type": [ "boolean", "null" ] }, "isPublic": { "examples": [ false ], "type": "boolean" }, "name": { "examples": [ "MyActor" ], "type": "string" }, "pricingInfos": { "items": { "$ref": "#/components/schemas/ActorRunPricingInfo" }, "type": "array" }, "restartOnError": { "deprecated": true, "examples": [ false ], "type": "boolean" }, "seoDescription": { "examples": [ "My actor is the best" ], "type": [ "string", "null" ] }, "seoTitle": { "examples": [ "My actor" ], "type": [ "string", "null" ] }, "taggedBuilds": { "additionalProperties": { "$ref": "#/components/schemas/BuildTag" }, "description": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n  \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n  \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n  \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```\n", "example": { "beta": null, "latest": { "buildId": "z2EryhbfhgSyqj6Hn" } }, "type": [ "object", "null" ] }, "title": { "examples": [ "My Actor" ], "type": [ "string", "null" ] }, "versions": { "description": "", "items": { "$ref": "#/components/schemas/CreateOrUpdateVersionRequest" }, "type": "array" } }, "title": "UpdateActorRequest", "type": "object" }, "UpdateDatasetRequest": { "example": { "generalAccess": "RESTRICTED", "name": "new-dataset-name" }, "properties": { "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "name": { "type": [ "string", "null" ] } }, "title": "UpdateDatasetRequest", "type": "object" }, "UpdateLimitsRequest": { "properties": { "dataRetentionDays": { "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/platform/storage/usage#data-retention).\n", "examples": [ 90 ], "type": "integer" }, "maxMonthlyUsageUsd": { "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", "examples": [ 300 ], "type": "number" } }, "title": "UpdateLimitsRequest", "type": "object" }, "UpdateRequestQueueRequest": { "description": "Request object for updating a request queue.", "example": { "generalAccess": "RESTRICTED", "name": "new-request-queue-name" }, "properties": { "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "name": { "description": "The new name for the request queue.", "type": [ "string", "null" ] } }, "title": "UpdateRequestQueueRequest", "type": "object" }, "UpdateRequestResponse": { "description": "Response containing the result of updating a request in the request queue.", "properties": { "data": { "$ref": "#/components/schemas/RequestRegistration" } }, "required": [ "data" ], "title": "UpdateRequestResponse", "type": "object" }, "UpdateRunRequest": { "properties": { "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "isStatusMessageTerminal": { "examples": [ true ], "type": "boolean" }, "runId": { "examples": [ "3KH8gEpp4d8uQSe8T" ], "type": "string" }, "statusMessage": { "examples": [ "Actor has finished" ], "type": "string" } }, "title": "UpdateRunRequest", "type": "object" }, "UpdateStoreRequest": { "example": { "generalAccess": "RESTRICTED", "name": "new-store-name" }, "properties": { "generalAccess": { "$ref": "#/components/schemas/GeneralAccess" }, "name": { "type": [ "string", "null" ] } }, "title": "UpdateStoreRequest", "type": "object" }, "UpdateTaskRequest": { "properties": { "actorStandby": { "anyOf": [ { "$ref": "#/components/schemas/ActorStandby" }, { "type": "null" } ] }, "input": { "anyOf": [ { "$ref": "#/components/schemas/TaskInput" }, { "type": "null" } ] }, "name": { "examples": [ "my-task" ], "type": "string" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/TaskOptions" }, { "type": "null" } ] }, "title": { "type": [ "string", "null" ] } }, "title": "UpdateTaskRequest", "type": "object" }, "UsageCycle": { "properties": { "endAt": { "examples": [ "2022-11-01T23:59:59.999Z" ], "format": "date-time", "type": "string" }, "startAt": { "examples": [ "2022-10-02T00:00:00.000Z" ], "format": "date-time", "type": "string" } }, "required": [ "startAt", "endAt" ], "title": "UsageCycle", "type": "object" }, "UsageItem": { "properties": { "amountAfterVolumeDiscountUsd": { "examples": [ 0.69611875 ], "type": "number" }, "baseAmountUsd": { "examples": [ 0.69611875 ], "type": "number" }, "baseUnitPriceUsd": { "examples": [ 0.25 ], "type": "number" }, "priceTiers": { "description": "", "items": { "$ref": "#/components/schemas/PriceTiers" }, "type": "array" }, "quantity": { "examples": [ 2.784475 ], "type": "number" } }, "required": [ "quantity", "baseAmountUsd" ], "title": "UsageItem", "type": "object" }, "UserPrivateInfo": { "properties": { "createdAt": { "examples": [ "2022-11-29T14:48:29.381Z" ], "format": "date-time", "type": "string" }, "effectivePlatformFeatures": { "$ref": "#/components/schemas/EffectivePlatformFeatures" }, "email": { "examples": [ "bob@example.com" ], "format": "email", "type": "string" }, "id": { "examples": [ "YiKoxjkaS9gjGTqhF" ], "type": "string" }, "isPaying": { "examples": [ true ], "type": "boolean" }, "plan": { "$ref": "#/components/schemas/Plan" }, "profile": { "$ref": "#/components/schemas/Profile" }, "proxy": { "$ref": "#/components/schemas/Proxy" }, "username": { "examples": [ "myusername" ], "type": "string" } }, "required": [ "id", "username", "profile", "email", "proxy", "plan", "effectivePlatformFeatures", "createdAt", "isPaying" ], "title": "UserPrivateInfo", "type": "object" }, "UserPublicInfo": { "properties": { "profile": { "$ref": "#/components/schemas/Profile" }, "username": { "examples": [ "d7b9MDYsbtX5L7XAj" ], "type": "string" } }, "required": [ "username" ], "title": "UserPublicInfo", "type": "object" }, "ValidationError": { "properties": { "instancePath": { "description": "The path to the instance being validated.", "type": "string" }, "keyword": { "description": "The validation keyword that caused the error.", "type": "string" }, "message": { "description": "A message describing the validation error.", "type": "string" }, "params": { "description": "Additional parameters specific to the validation error.", "type": "object" }, "schemaPath": { "description": "The path to the schema that failed the validation.", "type": "string" } }, "title": "ValidationError", "type": "object" }, "Version": { "properties": { "applyEnvVarsToBuild": { "examples": [ false ], "type": [ "boolean", "null" ] }, "buildTag": { "examples": [ "latest" ], "type": "string" }, "envVars": { "description": "", "items": { "$ref": "#/components/schemas/EnvVar" }, "type": [ "array", "null" ] }, "gitHubGistUrl": { "description": "URL of the GitHub Gist when sourceType is GITHUB_GIST.", "type": [ "string", "null" ] }, "gitRepoUrl": { "description": "URL of the Git repository when sourceType is GIT_REPO.", "type": [ "string", "null" ] }, "sourceFiles": { "$ref": "#/components/schemas/VersionSourceFiles" }, "sourceType": { "anyOf": [ { "$ref": "#/components/schemas/VersionSourceType" }, { "type": "null" } ] }, "tarballUrl": { "description": "URL of the tarball when sourceType is TARBALL.", "type": [ "string", "null" ] }, "versionNumber": { "examples": [ "0.0" ], "pattern": "^([0-9]|[1-9][0-9])\\.([0-9]|[1-9][0-9])$", "type": "string" } }, "required": [ "versionNumber", "sourceType" ], "title": "Version", "type": "object" }, "VersionResponse": { "properties": { "data": { "$ref": "#/components/schemas/Version" } }, "required": [ "data" ], "title": "VersionResponse", "type": "object" }, "VersionSourceFiles": { "items": { "anyOf": [ { "$ref": "#/components/schemas/SourceCodeFile" }, { "$ref": "#/components/schemas/SourceCodeFolder" } ] }, "title": "VersionSourceFiles", "type": "array" }, "VersionSourceType": { "enum": [ "SOURCE_FILES", "GIT_REPO", "TARBALL", "GITHUB_GIST", "SOURCE_CODE" ], "title": "VersionSourceType", "type": "string" }, "WasAlreadyHandled": { "description": "Indicates whether a request with the same unique key has already been processed by the request queue.", "examples": [ false ], "type": "boolean" }, "WasAlreadyPresent": { "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 ], "type": "boolean" }, "Webhook": { "properties": { "condition": { "$ref": "#/components/schemas/WebhookCondition" }, "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "description": { "examples": [ "this is webhook description" ], "type": [ "string", "null" ] }, "doNotRetry": { "examples": [ false ], "type": [ "boolean", "null" ] }, "eventTypes": { "examples": [ [ "ACTOR.RUN.SUCCEEDED" ] ], "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": "array" }, "headersTemplate": { "examples": [ "{\\n \"Authorization\": \"Bearer ...\"}" ], "type": [ "string", "null" ] }, "id": { "examples": [ "YiKoxjkaS9gjGTqhF" ], "type": "string" }, "ignoreSslErrors": { "examples": [ false ], "type": "boolean" }, "isAdHoc": { "examples": [ false ], "type": [ "boolean", "null" ] }, "lastDispatch": { "anyOf": [ { "$ref": "#/components/schemas/ExampleWebhookDispatch" }, { "type": "null" } ] }, "modifiedAt": { "examples": [ "2019-12-13T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "payloadTemplate": { "examples": [ "{\\n \"userId\": {{userId}}..." ], "type": [ "string", "null" ] }, "requestUrl": { "examples": [ "http://example.com/" ], "format": "uri", "type": "string" }, "shouldInterpolateStrings": { "examples": [ false ], "type": [ "boolean", "null" ] }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/WebhookStats" }, { "type": "null" } ] }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" } }, "required": [ "id", "createdAt", "modifiedAt", "userId", "eventTypes", "condition", "ignoreSslErrors", "requestUrl" ], "title": "Webhook", "type": "object" }, "WebhookCondition": { "properties": { "actorId": { "examples": [ "hksJZtadYvn4mBuin" ], "type": [ "string", "null" ] }, "actorRunId": { "examples": [ "hgdKZtadYvn4mBpoi" ], "type": [ "string", "null" ] }, "actorTaskId": { "examples": [ "asdLZtadYvn4mBZmm" ], "type": [ "string", "null" ] } }, "title": "WebhookCondition", "type": "object" }, "WebhookCreate": { "properties": { "condition": { "$ref": "#/components/schemas/WebhookCondition" }, "description": { "examples": [ "this is webhook description" ], "type": [ "string", "null" ] }, "doNotRetry": { "examples": [ false ], "type": [ "boolean", "null" ] }, "eventTypes": { "examples": [ [ "ACTOR.RUN.SUCCEEDED" ] ], "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": "array" }, "headersTemplate": { "examples": [ "{\\n \"Authorization\": \"Bearer ...\"}" ], "type": [ "string", "null" ] }, "idempotencyKey": { "examples": [ "fdSJmdP3nfs7sfk3y" ], "type": [ "string", "null" ] }, "ignoreSslErrors": { "examples": [ false ], "type": [ "boolean", "null" ] }, "isAdHoc": { "examples": [ false ], "type": [ "boolean", "null" ] }, "payloadTemplate": { "examples": [ "{\\n \"userId\": {{userId}}..." ], "type": [ "string", "null" ] }, "requestUrl": { "examples": [ "http://example.com/" ], "type": "string" }, "shouldInterpolateStrings": { "examples": [ false ], "type": [ "boolean", "null" ] } }, "required": [ "eventTypes", "condition", "requestUrl" ], "title": "WebhookCreate", "type": "object" }, "WebhookDispatch": { "properties": { "calls": { "items": { "properties": { "errorMessage": { "examples": [ "Cannot send request" ], "type": [ "string", "null" ] }, "finishedAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": [ "string", "null" ] }, "responseBody": { "example": "{\"foo\": \"bar\"}", "type": [ "string", "null" ] }, "responseStatus": { "examples": [ 200 ], "type": [ "integer", "null" ] }, "startedAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "title": "calls", "type": "array" }, "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "eventData": { "properties": { "actorId": { "examples": [ "vvE7iMKuMc5qTHHsR" ], "type": "string" }, "actorRunId": { "examples": [ "JgwXN9BdwxGcu9MMF" ], "type": "string" } }, "required": [ "actorId", "actorRunId" ], "title": "eventData", "type": [ "object", "null" ] }, "eventType": { "$ref": "#/components/schemas/WebhookEventType" }, "id": { "examples": [ "asdLZtadYvn4mBZmm" ], "type": "string" }, "status": { "$ref": "#/components/schemas/WebhookDispatchStatus" }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" }, "webhook": { "anyOf": [ { "$ref": "#/components/schemas/WebhookDispatchWebhookSummary" }, { "type": "null" } ] }, "webhookId": { "examples": [ "asdLZtadYvn4mBZmm" ], "type": "string" } }, "required": [ "id", "userId", "webhookId", "createdAt", "status", "eventType" ], "title": "WebhookDispatch", "type": "object" }, "WebhookDispatchResponse": { "properties": { "data": { "$ref": "#/components/schemas/WebhookDispatch" } }, "required": [ "data" ], "title": "WebhookDispatchResponse", "type": "object" }, "WebhookDispatchStatus": { "description": "Status of the webhook dispatch indicating whether the HTTP request was successful.", "enum": [ "ACTIVE", "SUCCEEDED", "FAILED" ], "title": "WebhookDispatchStatus", "type": "string" }, "WebhookDispatchWebhookSummary": { "description": "A summary of the webhook that triggered this dispatch.", "properties": { "actionType": { "examples": [ "HTTP_REQUEST" ], "type": "string" }, "condition": { "$ref": "#/components/schemas/WebhookCondition" }, "isAdHoc": { "examples": [ false ], "type": "boolean" }, "requestUrl": { "examples": [ "https://example.com/webhook" ], "format": "uri", "type": "string" } }, "title": "WebhookDispatchWebhookSummary", "type": "object" }, "WebhookEventType": { "description": "Type of event that triggers the webhook.", "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" ], "title": "WebhookEventType", "type": "string" }, "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", "properties": { "eventTypes": { "examples": [ [ "ACTOR.RUN.SUCCEEDED" ] ], "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": "array" }, "headersTemplate": { "description": "Optional template for the HTTP headers sent by the webhook.", "examples": [ "{\\n \"Authorization\": \"Bearer ...\"}" ], "type": [ "string", "null" ] }, "payloadTemplate": { "description": "Optional template for the JSON payload sent by the webhook.", "examples": [ "{\\n \"userId\": {{userId}}..." ], "type": [ "string", "null" ] }, "requestUrl": { "description": "The URL to which the webhook sends its payload.", "examples": [ "http://example.com/" ], "type": "string" } }, "required": [ "eventTypes", "requestUrl" ], "title": "WebhookRepresentation", "type": "object" }, "WebhookResponse": { "description": "Response containing webhook data.", "properties": { "data": { "$ref": "#/components/schemas/Webhook" } }, "required": [ "data" ], "title": "WebhookResponse", "type": "object" }, "WebhookShort": { "properties": { "actionType": { "examples": [ "HTTP_REQUEST" ], "type": "string" }, "condition": { "$ref": "#/components/schemas/WebhookCondition" }, "createdAt": { "examples": [ "2019-12-12T07:34:14.202Z" ], "format": "date-time", "type": "string" }, "doNotRetry": { "examples": [ false ], "type": "boolean" }, "eventTypes": { "examples": [ [ "ACTOR.RUN.SUCCEEDED" ] ], "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": "array" }, "id": { "examples": [ "YiKoxjkaS9gjGTqhF" ], "type": "string" }, "ignoreSslErrors": { "examples": [ false ], "type": "boolean" }, "isAdHoc": { "examples": [ false ], "type": [ "boolean", "null" ] }, "isApifyIntegration": { "examples": [ false ], "type": "boolean" }, "isEnabled": { "examples": [ true ], "type": "boolean" }, "lastDispatch": { "anyOf": [ { "$ref": "#/components/schemas/ExampleWebhookDispatch" }, { "type": "null" } ] }, "modifiedAt": { "examples": [ "2019-12-13T08:36:13.202Z" ], "format": "date-time", "type": "string" }, "requestUrl": { "examples": [ "http://example.com/" ], "format": "uri", "type": "string" }, "shouldInterpolateStrings": { "examples": [ false ], "type": [ "boolean", "null" ] }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/WebhookStats" }, { "type": "null" } ] }, "userId": { "examples": [ "wRsJZtadYvn4mBZmm" ], "type": "string" } }, "required": [ "id", "createdAt", "modifiedAt", "userId", "eventTypes", "condition", "ignoreSslErrors", "doNotRetry", "requestUrl" ], "title": "WebhookShort", "type": "object" }, "WebhookStats": { "properties": { "totalDispatches": { "examples": [ 1 ], "type": "integer" } }, "required": [ "totalDispatches" ], "title": "WebhookStats", "type": "object" }, "WebhookUpdate": { "properties": { "condition": { "anyOf": [ { "$ref": "#/components/schemas/WebhookCondition" }, { "type": "null" } ] }, "description": { "examples": [ "this is webhook description" ], "type": [ "string", "null" ] }, "doNotRetry": { "examples": [ false ], "type": [ "boolean", "null" ] }, "eventTypes": { "description": "", "examples": [ [ "ACTOR.RUN.SUCCEEDED" ] ], "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": [ "array", "null" ] }, "headersTemplate": { "examples": [ "{\\n \"Authorization\": \"Bearer ...\"}" ], "type": [ "string", "null" ] }, "ignoreSslErrors": { "examples": [ false ], "type": [ "boolean", "null" ] }, "isAdHoc": { "examples": [ false ], "type": [ "boolean", "null" ] }, "payloadTemplate": { "examples": [ "{\\n \"userId\": {{userId}}..." ], "type": [ "string", "null" ] }, "requestUrl": { "examples": [ "http://example.com/" ], "format": "uri", "type": [ "string", "null" ] }, "shouldInterpolateStrings": { "examples": [ false ], "type": [ "boolean", "null" ] } }, "title": "WebhookUpdate", "type": "object" } }, "securitySchemes": { "apiKey": { "description": "API token provided as a query parameter (e.g., `?token=your_token`\u2014less 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).", "in": "query", "name": "token", "type": "apiKey" }, "httpBearer": { "description": "Bearer token provided in the `Authorization` header (e.g., `Authorization: Bearer your_token`\u2014recommended). [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).", "scheme": "bearer", "type": "http" } } }, "info": { "contact": {}, "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\n- To access the API using [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- To access the API using [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\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<span id=\"/introduction/authentication\"></span>\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 <token>`.\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## Basic usage\n<span id=\"/introduction/basic-usage\"></span>\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<span id=\"/introduction/legacy-acts-prefix\"></span>\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<span id=\"/introduction/response-structure\"></span>\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<span id=\"/introduction/pagination\"></span>\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<span id=\"/introduction/pagination/using-offset\"></span>\n\nMost API endpoints that return a list of records enable pagination using the\nfollowing query parameters:\n\n<table>\n <tr>\n <td><code>limit</code></td>\n <td>Limits the response to contain a specific maximum number of items, e.g. <code>limit=20</code>.</td>\n </tr>\n <tr>\n <td><code>offset</code></td>\n <td>Skips a number of items from the beginning of the list, e.g. <code>offset=100</code>.</td>\n </tr>\n <tr>\n <td><code>desc</code></td>\n <td>\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 <code>desc=1</code> parameter, the items will be returned in the reverse order,\n i.e. from the newest to the oldest items.\n </td>\n </tr>\n</table>\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<table>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n <tr>\n <td><code>total</code></td>\n <td>The total number of items available in the list.</td>\n </tr>\n <tr>\n <td><code>offset</code></td>\n <td>The number of items that were skipped at the start.\n This is equal to the <code>offset</code> query parameter if it was provided, otherwise it is <code>0</code>.</td>\n </tr>\n <tr>\n <td><code>limit</code></td>\n <td>The maximum number of items that can be returned in the HTTP response.\n It equals to the <code>limit</code> query parameter if it was provided or\n the maximum limit enforced for the particular API endpoint, whichever is smaller.</td>\n </tr>\n <tr>\n <td><code>count</code></td>\n <td>The actual number of items returned in the HTTP response.</td>\n </tr>\n <tr>\n <td><code>desc</code></td>\n <td><code>true</code> if data were requested in descending order and <code>false</code> otherwise.</td>\n </tr>\n <tr>\n <td><code>items</code></td>\n <td>An array of requested items.</td>\n </tr>\n</table>\n\n### Using key\n<span id=\"/introduction/pagination/using-key\"></span>\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<table>\n <tr>\n <td><code>limit</code></td>\n <td>Limits the response to contain a specific maximum number items, e.g. <code>limit=20</code>.</td>\n </tr>\n <tr>\n <td><code>exclusiveStartKey</code></td>\n <td>Skips all records with keys up to the given key including the given key,\n in the UTF-8 binary order.</td>\n </tr>\n</table>\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<table>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n <tr>\n <td><code>limit</code></td>\n <td>The maximum number of items that can be returned in the HTTP response.\n It equals to the <code>limit</code> query parameter if it was provided or\n the maximum limit enforced for the particular endpoint, whichever is smaller.</td>\n </tr>\n <tr>\n <td><code>isTruncated</code></td>\n <td><code>true</code> if there are more items left to be queried. Otherwise <code>false</code>.</td>\n </tr>\n <tr>\n <td><code>exclusiveStartKey</code></td>\n <td>The last key that was skipped at the start. Is `null` for the first page.</td>\n </tr>\n <tr>\n <td><code>nextExclusiveStartKey</code></td>\n <td>The value for the <code>exclusiveStartKey</code> parameter to query the next page of items.</td>\n </tr>\n</table>\n\n## Errors\n<span id=\"/introduction/errors\"></span>\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<table>\n <tr>\n <th>status</th>\n <th>type</th>\n <th>message</th>\n </tr>\n <tr>\n <td><code>400</code></td>\n <td><code>invalid-request</code></td>\n <td>POST data must be a JSON object</td>\n </tr>\n <tr>\n <td><code>400</code></td>\n <td><code>invalid-value</code></td>\n <td>Invalid value provided: Comments required</td>\n </tr>\n <tr>\n <td><code>400</code></td>\n <td><code>invalid-record-key</code></td>\n <td>Record key contains invalid character</td>\n </tr>\n <tr>\n <td><code>401</code></td>\n <td><code>token-not-provided</code></td>\n <td>Authentication token was not provided</td>\n </tr>\n <tr>\n <td><code>404</code></td>\n <td><code>record-not-found</code></td>\n <td>Store was not found</td>\n </tr>\n <tr>\n <td><code>429</code></td>\n <td><code>rate-limit-exceeded</code></td>\n <td>You have exceeded the rate limit of ... requests per second</td>\n </tr>\n <tr>\n <td><code>405</code></td>\n <td><code>method-not-allowed</code></td>\n <td>This API endpoint can only be accessed using the following HTTP methods: OPTIONS, POST</td>\n </tr>\n</table>\n\n## Rate limiting\n<span id=\"/introduction/rate-limiting\"></span>\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<span id=\"/introduction/rate-limiting/global-rate-limit\"></span>\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<span id=\"/introduction/rate-limiting/per-resource-rate-limit\"></span>\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<span id=\"/introduction/rate-limiting/rate-limit-exceeded-errors\"></span>\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<span id=\"/introduction/rate-limiting/retrying-rate-limited-requests-with-exponential-backoff\"></span>\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<span id=\"/introduction/referring-to-resources\"></span>\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", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Apify API", "version": "v2-2026-05-28T120425Z" }, "openapi": "3.1.2", "paths": { "/v2/actor-builds": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfBuildsResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get user builds list", "tags": [ "Actor builds" ], "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" ] } }, "/v2/actor-builds/{buildId}": { "delete": { "deprecated": false, "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" } }, "summary": "Delete build", "tags": [ "Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#delete", "x-js-name": "delete", "x-js-parent": "BuildClient", "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" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/buildId" }, { "$ref": "#/components/parameters/waitForFinishBuild" } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuildResponse" } ] } } }, "description": "", "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" } }, "security": [], "summary": "Get build", "tags": [ "Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#get", "x-js-name": "get", "x-js-parent": "BuildClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildClientAsync#get", "x-py-name": "get", "x-py-parent": "BuildClientAsync" } }, "/v2/actor-builds/{buildId}/abort": { "post": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BuildResponse" } ] } } }, "description": "", "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" } }, "summary": "Abort build", "tags": [ "Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#abort", "x-js-name": "abort", "x-js-parent": "BuildClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildClientAsync#abort", "x-py-name": "abort", "x-py-parent": "BuildClientAsync" } }, "/v2/actor-builds/{buildId}/log": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "text/plain": { "schema": { "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", "type": "string" } } }, "description": "", "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" } }, "summary": "Get build's Log", "tags": [ "Actor builds" ], "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": { "description": "Get the OpenAPI definition for Actor builds. Two similar endpoints are available:\n\n- [First endpoint](/api/v2/act-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/act-openapi-json-get`](/api/v2/act-openapi-json-get) endpoint to get the OpenAPI definition for a build.\n\n:::\n", "operationId": "actorBuild_openapi_json_get", "parameters": [ { "$ref": "#/components/parameters/buildIdWithDefault" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "A standard OpenAPI 3.x JSON document.", "type": "object" } } }, "description": "The OpenAPI specification document for the Actor build.", "headers": {} }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [], "summary": "Get OpenAPI definition", "tags": [ "Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildClient#getOpenApiDefinition", "x-js-name": "getOpenApiDefinition", "x-js-parent": "BuildClient", "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildClient#get_open_api_definition", "x-py-name": "get_open_api_definition", "x-py-parent": "BuildClient" } }, "/v2/actor-runs": { "get": { "deprecated": false, "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": { "content": { "application/json": { "examples": { "example": { "$ref": "#/components/examples/ListOfRunsResponseExample" } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ListOfRunsResponse" } ] } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get user runs list", "tags": [ "Actor runs" ], "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}": { "delete": { "deprecated": false, "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" } }, "summary": "Delete run", "tags": [ "Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#delete", "x-js-name": "delete", "x-js-parent": "RunClient", "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" ] }, "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunResponse" } ] } } }, "description": "", "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" } }, "summary": "Get run", "tags": [ "Actor runs" ], "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": { "deprecated": false, "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": { "content": { "application/json": { "example": { "isStatusMessageTerminal": true, "runId": "3KH8gEpp4d8uQSe8T", "statusMessage": "Actor has finished" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateRunRequest" }, { "example": { "isStatusMessageTerminal": true, "runId": "3KH8gEpp4d8uQSe8T", "statusMessage": "Actor has finished" } } ] } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update run", "tags": [ "Actor runs" ], "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" ] } }, "/v2/actor-runs/{runId}/abort": { "post": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "actId": "janedoe~my-actor", "actorTaskId": "rANaydYhUxjsnA3oz", "buildId": "7sT5jcggjjA9fNcxF", "defaultDatasetId": "wmKPijuyDnPZAPRMk", "defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ", "defaultRequestQueueId": "FL35cSF7jrxr3BY39", "exitCode": 0, "finishedAt": "2019-12-12T09:30:12.202Z", "generalAccess": "RESTRICTED", "gitBranchName": "master", "id": "HG7ML7M8z78YcAPEB", "isContainerServerReady": false, "isStatusMessageTerminal": true, "meta": { "clientIp": "172.234.12.34", "origin": "WEB", "userAgent": "Mozilla/5.0 (iPad)" }, "options": { "build": "latest", "diskMbytes": 2048, "memoryMbytes": 1024, "timeoutSecs": 300 }, "startedAt": "2019-11-30T07:34:24.202Z", "stats": { "computeUnits": 0.0072886, "cpuAvgUsage": 0.00955965, "cpuCurrentUsage": 0, "cpuMaxUsage": 3.1546, "durationMillis": 26239, "inputBodyLen": 240, "memAvgBytes": 35914228.4, "memCurrentBytes": 0, "memMaxBytes": 38244352, "metamorph": 0, "migrationCount": 0, "netRxBytes": 2652, "netTxBytes": 1338, "restartCount": 0, "resurrectCount": 1, "runTimeSecs": 26.239 }, "status": "ABORTED", "statusMessage": "Actor was aborted", "storageIds": { "datasets": { "default": "wmKPijuyDnPZAPRMk" }, "keyValueStores": { "default": "eJNzqsbPiopwJcgGQ" }, "requestQueues": { "default": "FL35cSF7jrxr3BY39" } }, "usage": { "ACTOR_COMPUTE_UNITS": 3, "DATASET_READS": 4, "DATASET_WRITES": 4, "DATA_TRANSFER_EXTERNAL_GBYTES": 3, "DATA_TRANSFER_INTERNAL_GBYTES": 1, "KEY_VALUE_STORE_LISTS": 5, "KEY_VALUE_STORE_READS": 5, "KEY_VALUE_STORE_WRITES": 3, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34, "PROXY_SERPS": 3, "REQUEST_QUEUE_READS": 2, "REQUEST_QUEUE_WRITES": 1 }, "usageTotalUsd": 0.2654, "usageUsd": { "ACTOR_COMPUTE_UNITS": 0.072, "DATASET_READS": 0.0004, "DATASET_WRITES": 0.0002, "DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002, "DATA_TRANSFER_INTERNAL_GBYTES": 0.0004, "KEY_VALUE_STORE_LISTS": 0.004, "KEY_VALUE_STORE_READS": 0.0006, "KEY_VALUE_STORE_WRITES": 0.002, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16, "PROXY_SERPS": 0.0006, "REQUEST_QUEUE_READS": 0.005, "REQUEST_QUEUE_WRITES": 0.02 }, "userId": "BPWZBd7Z9c746JAng" } }, "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Abort run", "tags": [ "Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#abort", "x-js-name": "abort", "x-js-parent": "RunClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#abort", "x-py-name": "abort", "x-py-parent": "RunClientAsync" } }, "/v2/actor-runs/{runId}/charge": { "post": { "deprecated": false, "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](/platform/actors/publishing/monetize/pay-per-event).\n\n:::\n", "operationId": "PostChargeRun", "parameters": [ { "$ref": "#/components/parameters/runId" }, { "description": "Always pass a unique idempotency key (any unique string) for each charge to avoid double charging in case of retries or network errors.", "example": "2024-12-09T01:23:45.000Z-random-uuid", "in": "header", "name": "idempotency-key", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "count": 1, "eventName": "ANALYZE_PAGE" }, "schema": { "$ref": "#/components/schemas/ChargeRunRequest" } } }, "description": "Define which event, and how many times, you want to charge for.", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "type": "object" } } }, "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." }, "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" } }, "summary": "Charge events in run", "tags": [ "Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#charge", "x-js-name": "charge", "x-js-parent": "RunClient", "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" ], "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#charge", "x-py-name": "charge", "x-py-parent": "RunClientAsync" } }, "/v2/actor-runs/{runId}/dataset": { "delete": { "deprecated": false, "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", "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" } }, "summary": "Delete default dataset", "tags": [ "Default dataset" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" } }, "summary": "Get default dataset", "tags": [ "Default dataset" ] }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update default dataset", "tags": [ "Default dataset" ] } }, "/v2/actor-runs/{runId}/dataset/items": { "get": { "deprecated": false, "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/datasetParameters_limit" }, { "$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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "example": [ { "foo": "bar" }, { "foo2": "bar2" } ], "items": { "type": "object" }, "type": "array" } }, "application/jsonl": { "example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n", "schema": { "type": "string" } }, "application/rss+xml": { "example": "<rss><channel><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></channel></rss>", "schema": { "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string" } }, "application/xml": { "example": "<items><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></items>", "schema": { "type": "string" } }, "text/csv": { "example": "foo,bar\\nfoo2,bar2\\n", "schema": { "type": "string" } }, "text/html": { "example": "<table><tr><th>foo</th><th>bar</th></tr><tr><td>foo</td><td>bar</td></tr><tr><td>foo2</td><td>bar2</td></tr></table>", "schema": { "type": "string" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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" } }, "summary": "Get default dataset items", "tags": [ "Default dataset" ] }, "post": { "deprecated": false, "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", "operationId": "actorRun_dataset_items_post", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "oneOf": [ { "$ref": "#/components/schemas/PutItemsRequest" }, { "items": { "$ref": "#/components/schemas/PutItemsRequest" }, "type": "array" } ] } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "example": {}, "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items", "schema": { "type": "string" } } } } } }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PutItemResponseError" }, { "$ref": "#/components/schemas/ErrorResponse" } ] } } }, "description": "", "headers": {} }, "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" } }, "summary": "Store items", "tags": [ "Default dataset" ] } }, "/v2/actor-runs/{runId}/dataset/statistics": { "get": { "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetStatisticsResponse" } } }, "description": "" }, "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" } }, "summary": "Get default dataset statistics", "tags": [ "Default dataset" ] } }, "/v2/actor-runs/{runId}/key-value-store": { "delete": { "deprecated": false, "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", "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" } }, "summary": "Delete default store", "tags": [ "Default key-value store" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" } }, "summary": "Get default store", "tags": [ "Default key-value store" ] }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-store-name" }, "schema": { "$ref": "#/components/schemas/UpdateStoreRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update default store", "tags": [ "Default key-value store" ] } }, "/v2/actor-runs/{runId}/key-value-store/keys": { "get": { "deprecated": false, "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/keyValueStoreParameters_limit" }, { "$ref": "#/components/parameters/collectionKeys" }, { "$ref": "#/components/parameters/prefixKeys" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfKeysResponse" } } }, "description": "", "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" } }, "summary": "Get default store's list of keys", "tags": [ "Default key-value store" ] } }, "/v2/actor-runs/{runId}/key-value-store/records": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "A ZIP archive containing the requested records.", "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" } }, "summary": "Download default store's records", "tags": [ "Default key-value store" ] } }, "/v2/actor-runs/{runId}/key-value-store/records/{recordKey}": { "delete": { "deprecated": false, "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" } ], "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" } }, "summary": "Delete default store's record", "tags": [ "Default key-value store" ] }, "get": { "deprecated": false, "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/keyValueStoreParameters_attachment" } ], "responses": { "200": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/RecordResponse" } } }, "description": "", "headers": {} }, "302": { "content": {}, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Get default store's record", "tags": [ "Default key-value store" ] }, "post": { "deprecated": false, "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" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record in default store (POST)", "tags": [ "Default key-value store" ] }, "put": { "deprecated": false, "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" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record in default store", "tags": [ "Default key-value store" ] } }, "/v2/actor-runs/{runId}/log": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "text/plain": { "schema": { "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", "type": "string" } } }, "description": "", "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" } }, "summary": "Get run's log", "tags": [ "Actor runs" ] } }, "/v2/actor-runs/{runId}/metamorph": { "post": { "deprecated": false, "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" }, { "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", "explode": true, "in": "query", "name": "build", "schema": { "example": "beta", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Metamorph run", "tags": [ "Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#metamorph", "x-js-name": "metamorph", "x-js-parent": "RunClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#metamorph", "x-py-name": "metamorph", "x-py-parent": "RunClientAsync" } }, "/v2/actor-runs/{runId}/reboot": { "post": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Reboot run", "tags": [ "Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#reboot", "x-js-name": "reboot", "x-js-parent": "RunClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#reboot", "x-py-name": "reboot", "x-py-parent": "RunClientAsync" } }, "/v2/actor-runs/{runId}/request-queue": { "delete": { "deprecated": false, "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", "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" } }, "summary": "Delete default request queue", "tags": [ "Default request queue" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" } }, "summary": "Get default request queue", "tags": [ "Default request queue" ] }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/runId" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-request-queue-name" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateRequestQueueRequest" }, { "example": { "name": "new-request-queue-name" } } ] } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update default request queue", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/head": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadResponse" } } }, "description": "", "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" } }, "summary": "Get default request queue head", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/head/lock": { "post": { "deprecated": false, "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" } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadAndLockResponse" } } }, "description": "", "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" } }, "summary": "Get and lock default request queue head", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/requests": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfRequestsResponse" } } }, "description": "", "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" } }, "summary": "List default request queue's requests", "tags": [ "Default request queue" ] }, "post": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBase" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Add request to default request queue", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/requests/batch": { "delete": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RequestDraftDelete" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Batch delete requests from default request queue", "tags": [ "Default request queue" ] }, "post": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "items": { "$ref": "#/components/schemas/RequestBase" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Batch add requests to default request queue", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/requests/unlock": { "post": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlockRequestsResponse" } } }, "description": "Number of requests that were unlocked" }, "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" } }, "summary": "Unlock requests in default request queue", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/requests/{requestId}": { "delete": { "deprecated": false, "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" } ], "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" } }, "summary": "Delete request from default request queue", "tags": [ "Default request queue" ] }, "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestResponse" } } }, "description": "", "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" } }, "summary": "Get request from default request queue", "tags": [ "Default request queue" ] }, "put": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update request in default request queue", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/request-queue/requests/{requestId}/lock": { "delete": { "deprecated": false, "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" } ], "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" } }, "summary": "Delete lock on request in default request queue", "tags": [ "Default request queue" ] }, "put": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProlongRequestLockResponse" } } }, "description": "", "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" } }, "summary": "Prolong lock on request in default request queue", "tags": [ "Default request queue" ] } }, "/v2/actor-runs/{runId}/resurrect": { "post": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunResponse" } ] } } }, "description": "", "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" } }, "summary": "Resurrect run", "tags": [ "Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunClient#resurrect", "x-js-name": "resurrect", "x-js-parent": "RunClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunClientAsync#resurrect", "x-py-name": "resurrect", "x-py-parent": "RunClientAsync" } }, "/v2/actor-tasks": { "get": { "deprecated": false, "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": { "content": { "application/json": { "example": { "data": { "count": 2, "desc": false, "items": [ { "actId": "asADASadYvn4mBZmm", "actName": "my-actor", "actUsername": "janedoe", "createdAt": "2018-10-26T07:23:14.855Z", "id": "zdc3Pyhyz3m8vjDeM", "modifiedAt": "2018-10-26T13:30:49.578Z", "name": "my-task", "stats": { "totalRuns": 15 }, "userId": "wRsJZtadYvn4mBZmm", "username": "janedoe" }, { "actId": "asADASadYvn4mBZmm", "actName": "my-actor", "actUsername": "janedoe", "createdAt": "2018-10-26T07:23:14.855Z", "id": "aWE3asdas3m8vjDeM", "modifiedAt": "2018-10-26T13:30:49.578Z", "name": "my-task-2", "stats": { "totalRuns": 4 }, "userId": "wRsJZtadYvn4mBZmm", "username": "janedoe" } ], "limit": 1000, "offset": 0, "total": 2 } }, "schema": { "$ref": "#/components/schemas/ListOfTasksResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of tasks", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskCollectionClient#list", "x-js-name": "list", "x-js-parent": "TaskCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "TaskCollectionClientAsync" }, "post": { "deprecated": false, "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": { "content": { "application/json": { "example": { "actId": "asADASadYvn4mBZmm", "name": "my-task", "options": { "build": "latest", "memoryMbytes": 128, "timeoutSecs": 300 } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateTaskRequest" }, { "example": { "actId": "asADASadYvn4mBZmm", "input": { "hello": "world" }, "name": "my-task", "options": { "build": "latest", "memoryMbytes": 128, "timeoutSecs": 300 } } } ] } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actor-tasks/zdc3Pyhyz3m8vjDeM", "schema": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "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" } }, "summary": "Create task", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskCollectionClient#create", "x-js-name": "create", "x-js-parent": "TaskCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskCollectionClientAsync#create", "x-py-name": "create", "x-py-parent": "TaskCollectionClientAsync" } }, "/v2/actor-tasks/{actorTaskId}": { "delete": { "deprecated": false, "description": "Delete the task specified through the `actorTaskId` parameter.", "operationId": "actorTask_delete", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" } ], "responses": { "204": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "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" } }, "summary": "Delete task", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#delete", "x-js-name": "delete", "x-js-parent": "TaskClient", "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" ] }, "get": { "deprecated": false, "description": "Get an object that contains all the details about a task.", "operationId": "actorTask_get", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Task" } }, "required": [ "data" ], "type": "object" } } }, "description": "", "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" } }, "summary": "Get task", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#get", "x-js-name": "get", "x-js-parent": "TaskClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#get", "x-py-name": "get", "x-py-parent": "TaskClientAsync" }, "put": { "deprecated": false, "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 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": { "content": { "application/json": { "example": { "input": { "hello": "world" }, "name": "my-task", "options": { "build": "latest", "memoryMbytes": 128, "timeoutSecs": 300 } }, "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Task" } }, "required": [ "data" ], "type": "object" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update task", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#update", "x-js-name": "update", "x-js-parent": "TaskClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#update", "x-py-name": "update", "x-py-parent": "TaskClientAsync" } }, "/v2/actor-tasks/{actorTaskId}/input": { "get": { "deprecated": false, "description": "Returns the input of a given task.", "operationId": "actorTask_input_get", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" } ], "responses": { "200": { "content": { "application/json": { "example": { "myField1": "some-value", "myField2": "another-value", "myField3": 1 }, "schema": { "type": "object" } } }, "description": "", "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" } }, "summary": "Get task input", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#getInput", "x-js-name": "getInput", "x-js-parent": "TaskClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#get_input", "x-py-name": "get_input", "x-py-parent": "TaskClientAsync" }, "put": { "deprecated": false, "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": { "content": { "application/json": { "example": { "myField2": "updated-value" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "myField1": "some-value", "myField2": "updated-value", "myField3": 1 }, "schema": { "type": "object" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update task input", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#updateInput", "x-js-name": "updateInput", "x-js-parent": "TaskClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#update_input", "x-py-name": "update_input", "x-py-parent": "TaskClientAsync" } }, "/v2/actor-tasks/{actorTaskId}/run-sync": { "get": { "deprecated": false, "description": "Run a specific task and return its output.\n\nThe run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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/build" }, { "$ref": "#/components/parameters/outputRecordKey" }, { "$ref": "#/components/parameters/webhooks" } ], "responses": { "201": { "content": { "application/json": { "example": { "bar": "foo" }, "schema": { "type": "object" } } }, "description": "", "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" }, "408": { "$ref": "#/components/responses/RunTimeout" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run task synchronously", "tags": [ "Actor tasks" ], "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": { "deprecated": false, "description": "Runs an Actor task and synchronously returns its output.\n\nThe run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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": { "content": { "*/*": { "schema": {} }, "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "bar": "foo" }, "schema": { "type": "object" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run task synchronously", "tags": [ "Actor tasks" ], "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": { "deprecated": false, "description": "Run a specific task and return its dataset items.\n\nThe run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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/build" }, { "$ref": "#/components/parameters/webhooks" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/clean" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/datasetParameters_limit" }, { "$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": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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/RunTimeout" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run task synchronously and get dataset items", "tags": [ "Actor tasks" ], "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": { "deprecated": false, "description": "Runs an Actor task and synchronously returns its dataset items.\n\nThe run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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/datasetParameters_limit" }, { "$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": { "content": { "*/*": { "schema": {} }, "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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" } }, "summary": "Run task synchronously and get dataset items", "tags": [ "Actor tasks" ], "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": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/RunShort" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] } }, "required": [ "data" ], "type": "object" } } }, "description": "", "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" } }, "summary": "Get list of task runs", "tags": [ "Actor tasks" ], "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": { "deprecated": false, "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": { "content": { "*/*": { "schema": {} }, "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Run" } }, "required": [ "data" ], "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actor-tasks/zdc3Pyhyz3m8vjDeM/runs/HG7ML7M8z78YcAPEB", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Run task", "tags": [ "Actor tasks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/TaskClient#start", "x-js-name": "start", "x-js-parent": "TaskClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/TaskClientAsync#call", "x-py-name": "call", "x-py-parent": "TaskClientAsync" } }, "/v2/actor-tasks/{actorTaskId}/runs/last": { "get": { "deprecated": false, "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}`\n\nUsing the `status` query parameter you can ensure to only get a run with a certain status\n(e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters\nare 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/statusLastRun" }, { "$ref": "#/components/parameters/waitForFinishRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Run" } }, "required": [ "data" ], "type": "object" } } }, "description": "", "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" } }, "summary": "Get last run", "tags": [ "Actor tasks" ], "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/abort": { "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/gracefully" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "actId": "janedoe~my-actor", "actorTaskId": "rANaydYhUxjsnA3oz", "buildId": "7sT5jcggjjA9fNcxF", "defaultDatasetId": "wmKPijuyDnPZAPRMk", "defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ", "defaultRequestQueueId": "FL35cSF7jrxr3BY39", "exitCode": 0, "finishedAt": "2019-12-12T09:30:12.202Z", "generalAccess": "RESTRICTED", "gitBranchName": "master", "id": "HG7ML7M8z78YcAPEB", "isContainerServerReady": false, "isStatusMessageTerminal": true, "meta": { "clientIp": "172.234.12.34", "origin": "WEB", "userAgent": "Mozilla/5.0 (iPad)" }, "options": { "build": "latest", "diskMbytes": 2048, "memoryMbytes": 1024, "timeoutSecs": 300 }, "startedAt": "2019-11-30T07:34:24.202Z", "stats": { "computeUnits": 0.0072886, "cpuAvgUsage": 0.00955965, "cpuCurrentUsage": 0, "cpuMaxUsage": 3.1546, "durationMillis": 26239, "inputBodyLen": 240, "memAvgBytes": 35914228.4, "memCurrentBytes": 0, "memMaxBytes": 38244352, "metamorph": 0, "migrationCount": 0, "netRxBytes": 2652, "netTxBytes": 1338, "restartCount": 0, "resurrectCount": 1, "runTimeSecs": 26.239 }, "status": "ABORTED", "statusMessage": "Actor was aborted", "storageIds": { "datasets": { "default": "wmKPijuyDnPZAPRMk" }, "keyValueStores": { "default": "eJNzqsbPiopwJcgGQ" }, "requestQueues": { "default": "FL35cSF7jrxr3BY39" } }, "usage": { "ACTOR_COMPUTE_UNITS": 3, "DATASET_READS": 4, "DATASET_WRITES": 4, "DATA_TRANSFER_EXTERNAL_GBYTES": 3, "DATA_TRANSFER_INTERNAL_GBYTES": 1, "KEY_VALUE_STORE_LISTS": 5, "KEY_VALUE_STORE_READS": 5, "KEY_VALUE_STORE_WRITES": 3, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34, "PROXY_SERPS": 3, "REQUEST_QUEUE_READS": 2, "REQUEST_QUEUE_WRITES": 1 }, "usageTotalUsd": 0.2654, "usageUsd": { "ACTOR_COMPUTE_UNITS": 0.072, "DATASET_READS": 0.0004, "DATASET_WRITES": 0.0002, "DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002, "DATA_TRANSFER_INTERNAL_GBYTES": 0.0004, "KEY_VALUE_STORE_LISTS": 0.004, "KEY_VALUE_STORE_READS": 0.0006, "KEY_VALUE_STORE_WRITES": 0.002, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16, "PROXY_SERPS": 0.0006, "REQUEST_QUEUE_READS": 0.005, "REQUEST_QUEUE_WRITES": 0.02 }, "userId": "BPWZBd7Z9c746JAng" } }, "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Abort Actor task's last run", "tags": [ "Last Actor task run's abort" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/dataset": { "delete": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "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" } }, "summary": "Delete last task run's default dataset", "tags": [ "Last Actor task run's default dataset" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" } }, "summary": "Get last task run's default dataset", "tags": [ "Last Actor task run's default dataset" ] }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update last task run's default dataset", "tags": [ "Last Actor task run's default dataset" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/dataset/items": { "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/clean" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/datasetParameters_limit" }, { "$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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "example": [ { "foo": "bar" }, { "foo2": "bar2" } ], "items": { "type": "object" }, "type": "array" } }, "application/jsonl": { "example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n", "schema": { "type": "string" } }, "application/rss+xml": { "example": "<rss><channel><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></channel></rss>", "schema": { "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string" } }, "application/xml": { "example": "<items><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></items>", "schema": { "type": "string" } }, "text/csv": { "example": "foo,bar\\nfoo2,bar2\\n", "schema": { "type": "string" } }, "text/html": { "example": "<table><tr><th>foo</th><th>bar</th></tr><tr><td>foo</td><td>bar</td></tr><tr><td>foo2</td><td>bar2</td></tr></table>", "schema": { "type": "string" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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" } }, "summary": "Get last task run's dataset items", "tags": [ "Last Actor task run's default dataset" ] }, "post": { "deprecated": false, "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", "operationId": "actorTask_runs_last_dataset_items_post", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "oneOf": [ { "$ref": "#/components/schemas/PutItemsRequest" }, { "items": { "$ref": "#/components/schemas/PutItemsRequest" }, "type": "array" } ] } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "example": {}, "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items", "schema": { "type": "string" } } } } } }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PutItemResponseError" }, { "$ref": "#/components/schemas/ErrorResponse" } ] } } }, "description": "", "headers": {} }, "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" } }, "summary": "Store items in last task run's dataset", "tags": [ "Last Actor task run's default dataset" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/dataset/statistics": { "get": { "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/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetStatisticsResponse" } } }, "description": "" }, "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" } }, "summary": "Get last task run's dataset statistics", "tags": [ "Last Actor task run's default dataset" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store": { "delete": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "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" } }, "summary": "Delete last task run's default store", "tags": [ "Last Actor task run's default key-value store" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" } }, "summary": "Get last task run's default store", "tags": [ "Last Actor task run's default key-value store" ] }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-store-name" }, "schema": { "$ref": "#/components/schemas/UpdateStoreRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update last task run's default store", "tags": [ "Last Actor task run's default key-value store" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/keys": { "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/exclusiveStartKey" }, { "$ref": "#/components/parameters/keyValueStoreParameters_limit" }, { "$ref": "#/components/parameters/collectionKeys" }, { "$ref": "#/components/parameters/prefixKeys" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfKeysResponse" } } }, "description": "", "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" } }, "summary": "Get last task run's default store's list of keys", "tags": [ "Last Actor task run's default key-value store" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records": { "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/collectionRecords" }, { "$ref": "#/components/parameters/prefixRecords" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "A ZIP archive containing the requested records.", "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" } }, "summary": "Download last task run's default store's records", "tags": [ "Last Actor task run's default key-value store" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/key-value-store/records/{recordKey}": { "delete": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" } ], "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" } }, "summary": "Delete last task run's default store's record", "tags": [ "Last Actor task run's default key-value store" ] }, "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/keyValueStoreParameters_attachment" } ], "responses": { "200": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/RecordResponse" } } }, "description": "", "headers": {} }, "302": { "content": {}, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Get last task run's default store's record", "tags": [ "Last Actor task run's default key-value store" ] }, "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/Content-Encoding" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record in last task run's default store (POST)", "tags": [ "Last Actor task run's default key-value store" ] }, "put": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/Content-Encoding" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record in last task run's default store", "tags": [ "Last Actor task run's default key-value store" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/log": { "get": { "deprecated": false, "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/stream" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/raw" } ], "responses": { "200": { "content": { "text/plain": { "schema": { "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", "type": "string" } } }, "description": "", "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" } }, "summary": "Get last Actor task run's log", "tags": [ "Last Actor task run's log" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/metamorph": { "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/targetActorId" }, { "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", "explode": true, "in": "query", "name": "build", "schema": { "example": "beta", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Metamorph Actor task's last run", "tags": [ "Last Actor task run's metamorph" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/reboot": { "post": { "deprecated": false, "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/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Reboot Actor task's last run", "tags": [ "Last Actor task run's reboot" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue": { "delete": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "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" } }, "summary": "Delete last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" } }, "summary": "Get last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/actorTaskId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-request-queue-name" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateRequestQueueRequest" }, { "example": { "name": "new-request-queue-name" } } ] } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head": { "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/headLimit" }, { "$ref": "#/components/parameters/clientKey" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadResponse" } } }, "description": "", "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" } }, "summary": "Get last task run's default request queue head", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/head/lock": { "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/lockSecs" }, { "$ref": "#/components/parameters/headLockLimit" }, { "$ref": "#/components/parameters/clientKey" } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadAndLockResponse" } } }, "description": "", "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" } }, "summary": "Get and lock last task run's default request queue head", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests": { "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/exclusiveStartId" }, { "$ref": "#/components/parameters/listLimit" }, { "$ref": "#/components/parameters/cursor" }, { "$ref": "#/components/parameters/filter" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfRequestsResponse" } } }, "description": "", "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" } }, "summary": "List last task run's default request queue's requests", "tags": [ "Last Actor task run's default request queue" ] }, "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/forefront" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBase" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Add request to last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/batch": { "delete": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/contentTypeJson" }, { "$ref": "#/components/parameters/clientKey" } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RequestDraftDelete" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Batch delete requests from last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] }, "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/forefront" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "items": { "$ref": "#/components/schemas/RequestBase" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Batch add requests to last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/unlock": { "post": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlockRequestsResponse" } } }, "description": "Number of requests that were unlocked" }, "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" } }, "summary": "Unlock requests in last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}": { "delete": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/clientKey" } ], "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" } }, "summary": "Delete request from last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] }, "get": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/requestId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestResponse" } } }, "description": "", "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" } }, "summary": "Get request from last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] }, "put": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/forefront" }, { "$ref": "#/components/parameters/clientKey" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update request in last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/runs/last/request-queue/requests/{requestId}/lock": { "delete": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/deleteForefront" } ], "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" } }, "summary": "Delete lock on request in last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] }, "put": { "deprecated": false, "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/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/lockSecs" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/lockForefront" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProlongRequestLockResponse" } } }, "description": "", "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" } }, "summary": "Prolong lock on request in last task run's default request queue", "tags": [ "Last Actor task run's default request queue" ] } }, "/v2/actor-tasks/{actorTaskId}/webhooks": { "get": { "deprecated": false, "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": { "content": { "application/json": { "example": { "data": { "count": 2, "desc": false, "items": [ { "condition": { "actorId": "hksJZtadYvn4mBuin", "actorRunId": "hgdKZtadYvn4mBpoi", "actorTaskId": "asdLZtadYvn4mBZmm" }, "createdAt": "2019-12-12T07:34:14.202Z", "description": "this is webhook description", "doNotRetry": false, "eventTypes": [ "ACTOR.RUN.SUCCEEDED" ], "headersTemplate": "{\\n \\\"Authorization\\\": Bearer...", "id": "YiKoxjkaS9gjGTqhF", "ignoreSslErrors": false, "isAdHoc": false, "lastDispatch": { "finishedAt": "2019-12-13T08:36:13.202Z", "status": "SUCCEEDED" }, "modifiedAt": "2019-12-13T08:36:13.202Z", "payloadTemplate": "{\\n \\\"userId\\\": {{userId}}...", "requestUrl": "http://example.com/", "shouldInterpolateStrings": false, "stats": { "totalDispatches": 1 }, "userId": "wRsJZtadYvn4mBZmm" }, { "condition": { "actorId": "hksJZtadYvn4mBuin", "actorRunId": "hgdKZtadYvn4mBpoi", "actorTaskId": "asdLZtadYvn4mBZmm" }, "createdAt": "2019-12-12T07:34:14.202Z", "description": "this is webhook description", "doNotRetry": false, "eventTypes": [ "ACTOR.RUN.SUCCEEDED" ], "headersTemplate": "{\\n \\\"Authorization\\\": Bearer...", "id": "YiKoxjkaS9gjGTqhF", "ignoreSslErrors": false, "isAdHoc": false, "lastDispatch": { "finishedAt": "2019-12-13T08:36:13.202Z", "status": "SUCCEEDED" }, "modifiedAt": "2019-12-13T08:36:13.202Z", "payloadTemplate": "{\\n \\\"userId\\\": {{userId}}...", "requestUrl": "http://example.com/", "shouldInterpolateStrings": false, "stats": { "totalDispatches": 1 }, "userId": "wRsJZtadYvn4mBZmm" } ], "limit": 1000, "offset": 0, "total": 2 } }, "schema": { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "items": { "$ref": "#/components/schemas/Webhook" }, "type": "array" } }, "required": [ "items" ], "type": "object" } ] } }, "required": [ "data" ], "type": "object" } } }, "description": "", "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" } }, "summary": "Get list of webhooks", "tags": [ "Actor tasks" ], "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/actors": { "get": { "deprecated": false, "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": "acts_get", "parameters": [ { "description": "If `true` or `1` then the returned list only contains Actors owned by the user. The default value is `false`.\n", "explode": true, "in": "query", "name": "my", "schema": { "example": true, "type": "boolean" }, "style": "form" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/descCreatedAt" }, { "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", "in": "query", "name": "sortBy", "schema": { "enum": [ "createdAt", "stats.lastRunStartedAt" ], "example": "createdAt", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "count": 2, "desc": false, "items": [ { "createdAt": "2019-10-29T07:34:24.202Z", "id": "br9CKmk457", "modifiedAt": "2019-10-30T07:34:24.202Z", "name": "MyAct", "username": "janedoe" }, { "createdAt": "2019-11-30T07:34:24.202Z", "id": "ksiEKo23pz", "modifiedAt": "2019-12-12T07:34:24.202Z", "name": "MySecondAct", "username": "janedoe" } ], "limit": 1000, "offset": 0, "total": 2 } }, "schema": { "$ref": "#/components/schemas/ListOfActorsResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of Actors", "tags": [ "Actors" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorCollectionClient#list", "x-js-name": "list", "x-js-parent": "ActorCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "ActorCollectionClientAsync" }, "post": { "deprecated": false, "description": "Creates a new Actor with settings specified in an Actor object passed as\nJSON in the POST payload.\nThe response is the full Actor object as returned by the\n[Get Actor](#/reference/actors/actor-object/get-actor) endpoint.\n\nThe HTTP request must have the `Content-Type: application/json` HTTP header!\n\nThe Actor needs to define at least one version of the source code.\nFor more information, see [Version object](#/reference/actors/version-object).\n\nIf you want to make your Actor\n[public](https://docs.apify.com/platform/actors/publishing) using `isPublic:\ntrue`, you will need to provide the Actor's `title` and the `categories`\nunder which that Actor will be classified in Apify Store. For this, it's\nbest to use the [constants from our `apify-shared-js`\npackage](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471).\n", "operationId": "acts_post", "requestBody": { "content": { "application/json": { "example": { "categories": [], "defaultRunOptions": { "build": "latest", "memoryMbytes": 2048, "restartOnError": false, "timeoutSecs": 3600 }, "description": "My favourite Actor!", "isPublic": false, "name": "MyActor", "seoDescription": "My Actor is the best", "seoTitle": "My Actor", "title": "My Actor", "versions": [ { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": [ { "isSecret": false, "name": "DOMAIN", "value": "http://example.com" }, { "isSecret": true, "name": "SECRET_PASSWORD", "value": "MyTopSecretPassword123" } ], "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.0" } ] }, "schema": { "$ref": "#/components/schemas/CreateActorRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "createdAt": "2019-07-08T11:27:57.401Z", "defaultRunOptions": { "build": "latest", "memoryMbytes": 2048, "restartOnError": false, "timeoutSecs": 3600 }, "deploymentKey": "ssh-rsa AAAA ...", "description": "My favourite Actor!", "exampleRunInput": { "body": "{ \"helloWorld\": 123 }", "contentType": "application/json; charset=utf-8" }, "id": "zdc3Pyhyz3m8vjDeM", "isDeprecated": false, "isPublic": false, "modifiedAt": "2019-07-08T14:01:05.546Z", "name": "MyActor", "stats": { "lastRunStartedAt": "2019-07-08T14:01:05.546Z", "totalBuilds": 9, "totalMetamorphs": 2, "totalRuns": 16, "totalUsers": 6, "totalUsers30Days": 6, "totalUsers7Days": 2, "totalUsers90Days": 6 }, "taggedBuilds": { "latest": { "buildId": "z2EryhbfhgSyqj6Hn", "buildNumber": "0.0.2", "finishedAt": "2019-06-10T11:15:49.286Z" } }, "title": "My Actor", "userId": "wRsJZtadYvn4mBZmm", "username": "jane35", "versions": [ { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.1" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitRepoUrl": "https://github.com/jane35/my-actor", "sourceType": "GIT_REPO", "versionNumber": "0.2" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceType": "TARBALL", "tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip", "versionNumber": "0.3" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89", "sourceType": "GITHUB_GIST", "versionNumber": "0.4" } ] } }, "schema": { "$ref": "#/components/schemas/ActorResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create Actor", "tags": [ "Actors" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorCollectionClient#create", "x-js-name": "create", "x-js-parent": "ActorCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorCollectionClientAsync#create", "x-py-name": "create", "x-py-parent": "ActorCollectionClientAsync" } }, "/v2/actors/{actorId}": { "delete": { "deprecated": false, "description": "Deletes an Actor.", "operationId": "act_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" } ], "responses": { "204": { "content": { "application/json": { "example": {}, "schema": { "example": {}, "type": "object" } } }, "description": "", "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" } }, "summary": "Delete Actor", "tags": [ "Actors" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#delete", "x-js-name": "delete", "x-js-parent": "ActorClient", "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" ] }, "get": { "deprecated": false, "description": "Gets an object that contains all the details about a specific Actor.", "operationId": "act_get", "parameters": [ { "$ref": "#/components/parameters/actorId" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "createdAt": "2019-07-08T11:27:57.401Z", "defaultRunOptions": { "build": "latest", "memoryMbytes": 2048, "restartOnError": false, "timeoutSecs": 3600 }, "deploymentKey": "ssh-rsa AAAA ...", "description": "My favourite Actor!", "exampleRunInput": { "body": "{ \"helloWorld\": 123 }", "contentType": "application/json; charset=utf-8" }, "id": "zdc3Pyhyz3m8vjDeM", "isDeprecated": false, "isPublic": false, "modifiedAt": "2019-07-08T14:01:05.546Z", "name": "MyActor", "stats": { "lastRunStartedAt": "2019-07-08T14:01:05.546Z", "totalBuilds": 9, "totalMetamorphs": 2, "totalRuns": 16, "totalUsers": 6, "totalUsers30Days": 6, "totalUsers7Days": 2, "totalUsers90Days": 6 }, "taggedBuilds": { "latest": { "buildId": "z2EryhbfhgSyqj6Hn", "buildNumber": "0.0.2", "finishedAt": "2019-06-10T11:15:49.286Z" } }, "title": "My Actor", "userId": "wRsJZtadYvn4mBZmm", "username": "jane35", "versions": [ { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.1" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitRepoUrl": "https://github.com/jane35/my-actor", "sourceType": "GIT_REPO", "versionNumber": "0.2" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceType": "TARBALL", "tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip", "versionNumber": "0.3" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89", "sourceType": "GITHUB_GIST", "versionNumber": "0.4" } ] } }, "schema": { "$ref": "#/components/schemas/ActorResponse" } } }, "description": "", "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" } }, "summary": "Get Actor", "tags": [ "Actors" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#get", "x-js-name": "get", "x-js-parent": "ActorClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#get", "x-py-name": "get", "x-py-parent": "ActorClientAsync" }, "put": { "deprecated": false, "description": "Updates settings of an Actor using values specified by an Actor 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 response is the full Actor object as returned by the\n[Get Actor](#/reference/actors/actor-object/get-actor) 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. ([More\ninfo](#/introduction/authentication)).\n\nIf you want to make your Actor\n[public](https://docs.apify.com/platform/actors/publishing) using `isPublic:\ntrue`, you will need to provide the Actor's `title` and the `categories`\nunder which that Actor will be classified in Apify Store. For this, it's\nbest to use the [constants from our `apify-shared-js`\npackage](https://github.com/apify/apify-shared-js/blob/2d43ebc41ece9ad31cd6525bd523fb86939bf860/packages/consts/src/consts.ts#L452-L471).\n", "operationId": "act_put", "parameters": [ { "$ref": "#/components/parameters/actorId" } ], "requestBody": { "content": { "application/json": { "examples": { "common": { "summary": "Common example", "value": { "actorPermissionLevel": "LIMITED_PERMISSIONS", "categories": [], "defaultRunOptions": { "build": "latest", "memoryMbytes": 2048, "restartOnError": false, "timeoutSecs": 3600 }, "description": "My favourite Actor!", "isPublic": false, "name": "MyActor", "seoDescription": "My Actor is the best", "seoTitle": "My Actor", "title": "My Actor", "versions": [ { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": [ { "isSecret": false, "name": "DOMAIN", "value": "http://example.com" }, { "isSecret": true, "name": "SECRET_PASSWORD", "value": "MyTopSecretPassword123" } ], "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.0" } ] } }, "taggedBuildsCreateOrReassignTag": { "summary": "Create or reassign a build tag", "value": { "isPublic": false, "name": "MyActor", "taggedBuilds": { "latest": { "buildId": "z2EryhbfhgSyqj6Hn" } }, "versions": [] } }, "taggedBuildsMultipleOperations": { "summary": "Update multiple build tags at once", "value": { "isPublic": false, "name": "MyActor", "taggedBuilds": { "beta": null, "latest": { "buildId": "z2EryhbfhgSyqj6Hn" } }, "versions": [] } }, "taggedBuildsRemoveTag": { "summary": "Remove a build tag", "value": { "isPublic": false, "name": "MyActor", "taggedBuilds": { "latest": null }, "versions": [] } } }, "schema": { "$ref": "#/components/schemas/UpdateActorRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "actorPermissionLevel": "LIMITED_PERMISSIONS", "createdAt": "2019-07-08T11:27:57.401Z", "defaultRunOptions": { "build": "latest", "memoryMbytes": 2048, "restartOnError": false, "timeoutSecs": 3600 }, "deploymentKey": "ssh-rsa AAAA ...", "description": "My favourite Actor!", "exampleRunInput": { "body": "{ \"helloWorld\": 123 }", "contentType": "application/json; charset=utf-8" }, "id": "zdc3Pyhyz3m8vjDeM", "isDeprecated": false, "isPublic": false, "modifiedAt": "2019-07-08T14:01:05.546Z", "name": "MyActor", "stats": { "lastRunStartedAt": "2019-07-08T14:01:05.546Z", "totalBuilds": 9, "totalMetamorphs": 2, "totalRuns": 16, "totalUsers": 6, "totalUsers30Days": 6, "totalUsers7Days": 2, "totalUsers90Days": 6 }, "taggedBuilds": { "latest": { "buildId": "z2EryhbfhgSyqj6Hn", "buildNumber": "0.0.2", "finishedAt": "2019-06-10T11:15:49.286Z" } }, "title": "My Actor", "userId": "wRsJZtadYvn4mBZmm", "username": "jane35", "versions": [ { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.1" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitRepoUrl": "https://github.com/jane35/my-actor", "sourceType": "GIT_REPO", "versionNumber": "0.2" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceType": "TARBALL", "tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip", "versionNumber": "0.3" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89", "sourceType": "GITHUB_GIST", "versionNumber": "0.4" } ] } }, "schema": { "$ref": "#/components/schemas/ActorResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update Actor", "tags": [ "Actors" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#update", "x-js-name": "update", "x-js-parent": "ActorClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#update", "x-py-name": "update", "x-py-parent": "ActorClientAsync" } }, "/v2/actors/{actorId}/builds": { "get": { "deprecated": false, "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": "act_builds_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/descStartedAt" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfBuildsResponse" } } }, "description": "", "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" } }, "summary": "Get list of builds", "tags": [ "Actors/Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/BuildCollectionClient#list", "x-js-name": "list", "x-js-parent": "BuildCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "BuildCollectionClientAsync" }, "post": { "deprecated": false, "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": "act_builds_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "description": "Actor version number to be built.", "explode": true, "in": "query", "name": "version", "required": true, "schema": { "example": "0.0", "type": "string" }, "style": "form" }, { "description": "If `true` or `1`, the system will use a cache to speed up the build\nprocess. By default, cache is not used.\n", "explode": true, "in": "query", "name": "useCache", "schema": { "example": true, "type": "boolean" }, "style": "form" }, { "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", "explode": true, "in": "query", "name": "betaPackages", "schema": { "example": true, "type": "boolean" }, "style": "form" }, { "description": "Tag to be applied to the build on success. By default, the tag is taken\nfrom Actor version's `buildTag` property.\n", "explode": true, "in": "query", "name": "tag", "schema": { "example": "latest", "type": "string" }, "style": "form" }, { "$ref": "#/components/parameters/waitForFinishBuild" } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/runs/HG7ML7M8z78YcAPEB", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Build Actor", "tags": [ "Actors/Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#build", "x-js-name": "build", "x-js-parent": "ActorClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#build", "x-py-name": "build", "x-py-parent": "ActorClientAsync" } }, "/v2/actors/{actorId}/builds/default": { "get": { "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": "act_build_default_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/waitForFinishBuild" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildResponse" } } }, "description": "", "headers": {} }, "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" } }, "security": [], "summary": "Get default build", "tags": [ "Actors/Actor builds" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#defaultBuild", "x-js-name": "defaultBuild", "x-js-parent": "ActorClient", "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClient#default_build", "x-py-name": "default_build", "x-py-parent": "ActorClient" } }, "/v2/actors/{actorId}/builds/{buildId}": { "get": { "deprecated": true, "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": "act_build_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/buildId" }, { "$ref": "#/components/parameters/waitForFinishBuild" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuildResponse" } } }, "description": "", "headers": {} }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [], "summary": "Get build", "tags": [ "Actors/Actor builds" ], "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": { "deprecated": true, "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": "act_build_abort_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/buildId" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "actId": "janedoe~my-actor", "buildNumber": "0.1.1", "finishedAt": "2019-12-12T09:30:12.202Z", "id": "HG7ML7M8z78YcAPEB", "meta": { "origin": "WEB", "userAgent": "Mozilla/5.0 (iPad)" }, "options": { "diskMbytes": 2048, "memoryMbytes": 1024, "useCache": false }, "startedAt": "2019-11-30T07:34:24.202Z", "stats": { "computeUnits": 0.012699444444444444, "durationMillis": 1000, "runTimeSecs": 5.718 }, "status": "ABORTED", "usage": { "ACTOR_COMPUTE_UNITS": 0.08 }, "usageTotalUsd": 0.02, "usageUsd": { "ACTOR_COMPUTE_UNITS": 0.02 }, "userId": "klmdEpoiojmdEMlk3" } }, "schema": { "$ref": "#/components/schemas/BuildResponse" } } }, "description": "", "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" } }, "summary": "Abort build", "tags": [ "Actors/Actor builds" ], "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}/builds/{buildId}/openapi.json": { "get": { "description": "Get the OpenAPI definition for Actor builds. Two similar endpoints are available:\n\n- [First endpoint](/api/v2/act-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": "act_openapi_json_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/buildIdWithDefault" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "A standard OpenAPI 3.x JSON document.", "type": "object" } } }, "description": "The OpenAPI specification document for the Actor build.", "headers": {} }, "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" } }, "security": [], "summary": "Get OpenAPI definition", "tags": [ "Actors/Actor builds" ] } }, "/v2/actors/{actorId}/run-sync": { "get": { "deprecated": false, "description": "Runs a specific Actor and returns its output.\nThe run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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": "act_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": { "content": { "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "headers": {} }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunFailedError" } } }, "description": "", "headers": {} }, "404": { "$ref": "#/components/responses/NotFound" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunTimeoutExceededError" } } }, "description": "", "headers": {} }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run Actor synchronously without input", "tags": [ "Actors/Actor runs" ], "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" ] }, "post": { "deprecated": false, "description": "Runs a specific Actor and returns its output.\n\nThe POST payload including its `Content-Type` header is passed as `INPUT` to\nthe Actor (usually <code>application/json</code>).\nThe HTTP response contains Actors `OUTPUT` record from its default\nkey-value store.\n\nThe Actor is started with the default options; you can override them using\nvarious URL query parameters.\nIf the Actor run exceeds 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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": "act_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": { "content": { "*/*": { "schema": {} }, "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "bar": "foo" }, "schema": { "type": "object" } } }, "description": "", "headers": {} }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunFailedError" } } }, "description": "", "headers": {} }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "404": { "$ref": "#/components/responses/NotFound" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunTimeoutExceededError" } } }, "description": "", "headers": {} }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run Actor synchronously and return output", "tags": [ "Actors/Actor runs" ], "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" ] } }, "/v2/actors/{actorId}/run-sync-get-dataset-items": { "get": { "deprecated": false, "description": "Runs a specific Actor and returns its dataset items.\nThe run must finish in 300<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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": "act_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/datasetParameters_limit" }, { "$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": { "content": { "application/json": { "example": [ { "myOtherValue": "some other value", "myValue": "some value" } ], "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunFailedError" } } }, "description": "", "headers": {} }, "404": { "$ref": "#/components/responses/NotFound" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunTimeoutExceededError" } } }, "description": "", "headers": {} }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run Actor synchronously without input and get dataset items", "tags": [ "Actors/Actor runs" ], "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" ] }, "post": { "deprecated": false, "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<!-- MAX_ACTOR_JOB_SYNC_WAIT_SECS --> 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": "act_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/datasetParameters_limit" }, { "$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": { "content": { "*/*": { "schema": {} }, "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": [ { "myOtherValue": "some other value", "myValue": "some value" } ], "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunFailedError" } } }, "description": "", "headers": {} }, "402": { "$ref": "#/components/responses/PaymentRequired" }, "404": { "$ref": "#/components/responses/NotFound" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActorRunTimeoutExceededError" } } }, "description": "", "headers": {} }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Run Actor synchronously and get dataset items", "tags": [ "Actors/Actor runs" ], "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" ] } }, "/v2/actors/{actorId}/runs": { "get": { "deprecated": false, "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": "act_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": { "content": { "application/json": { "examples": { "example": { "$ref": "#/components/examples/ListOfRunsResponseExample" } }, "schema": { "$ref": "#/components/schemas/ListOfRunsResponse" } } }, "description": "", "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" } }, "summary": "Get list of runs", "tags": [ "Actors/Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RunCollectionClient#list", "x-js-name": "list", "x-js-parent": "RunCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RunCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "RunCollectionClientAsync" }, "post": { "deprecated": false, "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": "act_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" }, { "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", "explode": true, "in": "query", "name": "forcePermissionLevel", "schema": { "enum": [ "LIMITED_PERMISSIONS", "FULL_PERMISSIONS" ], "example": "LIMITED_PERMISSIONS", "type": "string" }, "style": "form" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "example": { "foo": "bar" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/runs/HG7ML7M8z78YcAPEB", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Run Actor", "tags": [ "Actors/Actor runs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ActorClient#start", "x-js-name": "start", "x-js-parent": "ActorClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorClientAsync#call", "x-py-name": "call", "x-py-parent": "ActorClientAsync" } }, "/v2/actors/{actorId}/runs/last": { "get": { "deprecated": false, "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}`\n\nUsing the `status` query parameter you can ensure to only get a run with a certain status\n(e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters\nare 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": "act_runs_last_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/waitForFinishRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Get last run", "tags": [ "Actors/Actor runs" ], "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/abort": { "post": { "deprecated": false, "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": "act_runs_last_abort_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/gracefully" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "actId": "janedoe~my-actor", "actorTaskId": "rANaydYhUxjsnA3oz", "buildId": "7sT5jcggjjA9fNcxF", "defaultDatasetId": "wmKPijuyDnPZAPRMk", "defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ", "defaultRequestQueueId": "FL35cSF7jrxr3BY39", "exitCode": 0, "finishedAt": "2019-12-12T09:30:12.202Z", "generalAccess": "RESTRICTED", "gitBranchName": "master", "id": "HG7ML7M8z78YcAPEB", "isContainerServerReady": false, "isStatusMessageTerminal": true, "meta": { "clientIp": "172.234.12.34", "origin": "WEB", "userAgent": "Mozilla/5.0 (iPad)" }, "options": { "build": "latest", "diskMbytes": 2048, "memoryMbytes": 1024, "timeoutSecs": 300 }, "startedAt": "2019-11-30T07:34:24.202Z", "stats": { "computeUnits": 0.0072886, "cpuAvgUsage": 0.00955965, "cpuCurrentUsage": 0, "cpuMaxUsage": 3.1546, "durationMillis": 26239, "inputBodyLen": 240, "memAvgBytes": 35914228.4, "memCurrentBytes": 0, "memMaxBytes": 38244352, "metamorph": 0, "migrationCount": 0, "netRxBytes": 2652, "netTxBytes": 1338, "restartCount": 0, "resurrectCount": 1, "runTimeSecs": 26.239 }, "status": "ABORTED", "statusMessage": "Actor was aborted", "storageIds": { "datasets": { "default": "wmKPijuyDnPZAPRMk" }, "keyValueStores": { "default": "eJNzqsbPiopwJcgGQ" }, "requestQueues": { "default": "FL35cSF7jrxr3BY39" } }, "usage": { "ACTOR_COMPUTE_UNITS": 3, "DATASET_READS": 4, "DATASET_WRITES": 4, "DATA_TRANSFER_EXTERNAL_GBYTES": 3, "DATA_TRANSFER_INTERNAL_GBYTES": 1, "KEY_VALUE_STORE_LISTS": 5, "KEY_VALUE_STORE_READS": 5, "KEY_VALUE_STORE_WRITES": 3, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34, "PROXY_SERPS": 3, "REQUEST_QUEUE_READS": 2, "REQUEST_QUEUE_WRITES": 1 }, "usageTotalUsd": 0.2654, "usageUsd": { "ACTOR_COMPUTE_UNITS": 0.072, "DATASET_READS": 0.0004, "DATASET_WRITES": 0.0002, "DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002, "DATA_TRANSFER_INTERNAL_GBYTES": 0.0004, "KEY_VALUE_STORE_LISTS": 0.004, "KEY_VALUE_STORE_READS": 0.0006, "KEY_VALUE_STORE_WRITES": 0.002, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16, "PROXY_SERPS": 0.0006, "REQUEST_QUEUE_READS": 0.005, "REQUEST_QUEUE_WRITES": 0.02 }, "userId": "BPWZBd7Z9c746JAng" } }, "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Abort Actor's last run", "tags": [ "Last Actor run's abort" ] } }, "/v2/actors/{actorId}/runs/last/dataset": { "delete": { "deprecated": false, "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": "act_runs_last_dataset_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "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" } }, "summary": "Delete last run's default dataset", "tags": [ "Last Actor run's default dataset" ] }, "get": { "deprecated": false, "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": "act_runs_last_dataset_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" } }, "summary": "Get last run's default dataset", "tags": [ "Last Actor run's default dataset" ] }, "put": { "deprecated": false, "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": "act_runs_last_dataset_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update last run's default dataset", "tags": [ "Last Actor run's default dataset" ] } }, "/v2/actors/{actorId}/runs/last/dataset/items": { "get": { "deprecated": false, "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": "act_runs_last_dataset_items_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/clean" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/datasetParameters_limit" }, { "$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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "example": [ { "foo": "bar" }, { "foo2": "bar2" } ], "items": { "type": "object" }, "type": "array" } }, "application/jsonl": { "example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n", "schema": { "type": "string" } }, "application/rss+xml": { "example": "<rss><channel><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></channel></rss>", "schema": { "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string" } }, "application/xml": { "example": "<items><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></items>", "schema": { "type": "string" } }, "text/csv": { "example": "foo,bar\\nfoo2,bar2\\n", "schema": { "type": "string" } }, "text/html": { "example": "<table><tr><th>foo</th><th>bar</th></tr><tr><td>foo</td><td>bar</td></tr><tr><td>foo2</td><td>bar2</td></tr></table>", "schema": { "type": "string" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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" } }, "summary": "Get last run's dataset items", "tags": [ "Last Actor run's default dataset" ] }, "post": { "deprecated": false, "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", "operationId": "act_runs_last_dataset_items_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "oneOf": [ { "$ref": "#/components/schemas/PutItemsRequest" }, { "items": { "$ref": "#/components/schemas/PutItemsRequest" }, "type": "array" } ] } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "example": {}, "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items", "schema": { "type": "string" } } } } } }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PutItemResponseError" }, { "$ref": "#/components/schemas/ErrorResponse" } ] } } }, "description": "", "headers": {} }, "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" } }, "summary": "Store items in last run's dataset", "tags": [ "Last Actor run's default dataset" ] } }, "/v2/actors/{actorId}/runs/last/dataset/statistics": { "get": { "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": "act_runs_last_dataset_statistics_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetStatisticsResponse" } } }, "description": "" }, "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" } }, "summary": "Get last run's dataset statistics", "tags": [ "Last Actor run's default dataset" ] } }, "/v2/actors/{actorId}/runs/last/key-value-store": { "delete": { "deprecated": false, "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": "act_runs_last_keyValueStore_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "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" } }, "summary": "Delete last run's default store", "tags": [ "Last Actor run's default key-value store" ] }, "get": { "deprecated": false, "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": "act_runs_last_keyValueStore_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" } }, "summary": "Get last run's default store", "tags": [ "Last Actor run's default key-value store" ] }, "put": { "deprecated": false, "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": "act_runs_last_keyValueStore_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-store-name" }, "schema": { "$ref": "#/components/schemas/UpdateStoreRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update last run's default store", "tags": [ "Last Actor run's default key-value store" ] } }, "/v2/actors/{actorId}/runs/last/key-value-store/keys": { "get": { "deprecated": false, "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": "act_runs_last_keyValueStore_keys_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/exclusiveStartKey" }, { "$ref": "#/components/parameters/keyValueStoreParameters_limit" }, { "$ref": "#/components/parameters/collectionKeys" }, { "$ref": "#/components/parameters/prefixKeys" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfKeysResponse" } } }, "description": "", "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" } }, "summary": "Get last run's default store's list of keys", "tags": [ "Last Actor run's default key-value store" ] } }, "/v2/actors/{actorId}/runs/last/key-value-store/records": { "get": { "deprecated": false, "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": "act_runs_last_keyValueStore_records_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/collectionRecords" }, { "$ref": "#/components/parameters/prefixRecords" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "A ZIP archive containing the requested records.", "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" } }, "summary": "Download last run's default store's records", "tags": [ "Last Actor run's default key-value store" ] } }, "/v2/actors/{actorId}/runs/last/key-value-store/records/{recordKey}": { "delete": { "deprecated": false, "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": "act_runs_last_keyValueStore_record_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" } ], "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" } }, "summary": "Delete last run's default store's record", "tags": [ "Last Actor run's default key-value store" ] }, "get": { "deprecated": false, "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": "act_runs_last_keyValueStore_record_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/keyValueStoreParameters_attachment" } ], "responses": { "200": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/RecordResponse" } } }, "description": "", "headers": {} }, "302": { "content": {}, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Get last run's default store's record", "tags": [ "Last Actor run's default key-value store" ] }, "post": { "deprecated": false, "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": "act_runs_last_keyValueStore_record_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/Content-Encoding" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record in last run's default store (POST)", "tags": [ "Last Actor run's default key-value store" ] }, "put": { "deprecated": false, "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": "act_runs_last_keyValueStore_record_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/Content-Encoding" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record in last run's default store", "tags": [ "Last Actor run's default key-value store" ] } }, "/v2/actors/{actorId}/runs/last/log": { "get": { "deprecated": false, "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": "act_runs_last_log_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/stream" }, { "$ref": "#/components/parameters/download" }, { "$ref": "#/components/parameters/raw" } ], "responses": { "200": { "content": { "text/plain": { "schema": { "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", "type": "string" } } }, "description": "", "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" } }, "summary": "Get last Actor run's log", "tags": [ "Last Actor run's log" ] } }, "/v2/actors/{actorId}/runs/last/metamorph": { "post": { "deprecated": false, "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": "act_runs_last_metamorph_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/targetActorId" }, { "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", "explode": true, "in": "query", "name": "build", "schema": { "example": "beta", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Metamorph Actor's last run", "tags": [ "Last Actor run's metamorph" ] } }, "/v2/actors/{actorId}/runs/last/reboot": { "post": { "deprecated": false, "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": "act_runs_last_reboot_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Reboot Actor's last run", "tags": [ "Last Actor run's reboot" ] } }, "/v2/actors/{actorId}/runs/last/request-queue": { "delete": { "deprecated": false, "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": "act_runs_last_requestQueue_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "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" } }, "summary": "Delete last run's default request queue", "tags": [ "Last Actor run's default request queue" ] }, "get": { "deprecated": false, "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": "act_runs_last_requestQueue_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" } }, "summary": "Get last run's default request queue", "tags": [ "Last Actor run's default request queue" ] }, "put": { "deprecated": false, "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": "act_runs_last_requestQueue_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-request-queue-name" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateRequestQueueRequest" }, { "example": { "name": "new-request-queue-name" } } ] } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update last run's default request queue", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/head": { "get": { "deprecated": false, "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": "act_runs_last_requestQueue_head_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/headLimit" }, { "$ref": "#/components/parameters/clientKey" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadResponse" } } }, "description": "", "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" } }, "summary": "Get last run's default request queue head", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/head/lock": { "post": { "deprecated": false, "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": "act_runs_last_requestQueue_head_lock_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/lockSecs" }, { "$ref": "#/components/parameters/headLockLimit" }, { "$ref": "#/components/parameters/clientKey" } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadAndLockResponse" } } }, "description": "", "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" } }, "summary": "Get and lock last run's default request queue head", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/requests": { "get": { "deprecated": false, "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": "act_runs_last_requestQueue_requests_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/exclusiveStartId" }, { "$ref": "#/components/parameters/listLimit" }, { "$ref": "#/components/parameters/cursor" }, { "$ref": "#/components/parameters/filter" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfRequestsResponse" } } }, "description": "", "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" } }, "summary": "List last run's default request queue's requests", "tags": [ "Last Actor run's default request queue" ] }, "post": { "deprecated": false, "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": "act_runs_last_requestQueue_requests_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/forefront" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBase" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Add request to last run's default request queue", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/requests/batch": { "delete": { "deprecated": false, "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": "act_runs_last_requestQueue_requests_batch_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/contentTypeJson" }, { "$ref": "#/components/parameters/clientKey" } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RequestDraftDelete" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Batch delete requests from last run's default request queue", "tags": [ "Last Actor run's default request queue" ] }, "post": { "deprecated": false, "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": "act_runs_last_requestQueue_requests_batch_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/forefront" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "items": { "$ref": "#/components/schemas/RequestBase" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Batch add requests to last run's default request queue", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/requests/unlock": { "post": { "deprecated": false, "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": "act_runs_last_requestQueue_requests_unlock_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/clientKey" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlockRequestsResponse" } } }, "description": "Number of requests that were unlocked" }, "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" } }, "summary": "Unlock requests in last run's default request queue", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}": { "delete": { "deprecated": false, "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": "act_runs_last_requestQueue_request_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/clientKey" } ], "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" } }, "summary": "Delete request from last run's default request queue", "tags": [ "Last Actor run's default request queue" ] }, "get": { "deprecated": false, "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": "act_runs_last_requestQueue_request_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/requestId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestResponse" } } }, "description": "", "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" } }, "summary": "Get request from last run's default request queue", "tags": [ "Last Actor run's default request queue" ] }, "put": { "deprecated": false, "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": "act_runs_last_requestQueue_request_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/forefront" }, { "$ref": "#/components/parameters/clientKey" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update request in last run's default request queue", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/last/request-queue/requests/{requestId}/lock": { "delete": { "deprecated": false, "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": "act_runs_last_requestQueue_request_lock_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/deleteForefront" } ], "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" } }, "summary": "Delete lock on request in last run's default request queue", "tags": [ "Last Actor run's default request queue" ] }, "put": { "deprecated": false, "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": "act_runs_last_requestQueue_request_lock_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/statusLastRun" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/lockSecs" }, { "$ref": "#/components/parameters/clientKey" }, { "$ref": "#/components/parameters/lockForefront" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProlongRequestLockResponse" } } }, "description": "", "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" } }, "summary": "Prolong lock on request in last run's default request queue", "tags": [ "Last Actor run's default request queue" ] } }, "/v2/actors/{actorId}/runs/{runId}": { "get": { "deprecated": true, "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": "act_run_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/runId" }, { "$ref": "#/components/parameters/waitForFinishRun" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Get run", "tags": [ "Actors/Actor runs" ], "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": { "deprecated": true, "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": "act_run_abort_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/runId" }, { "$ref": "#/components/parameters/gracefully" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "actId": "janedoe~my-actor", "actorTaskId": "rANaydYhUxjsnA3oz", "buildId": "7sT5jcggjjA9fNcxF", "defaultDatasetId": "wmKPijuyDnPZAPRMk", "defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ", "defaultRequestQueueId": "FL35cSF7jrxr3BY39", "exitCode": 0, "finishedAt": "2019-12-12T09:30:12.202Z", "generalAccess": "RESTRICTED", "gitBranchName": "master", "id": "HG7ML7M8z78YcAPEB", "isContainerServerReady": false, "isStatusMessageTerminal": true, "meta": { "clientIp": "172.234.12.34", "origin": "WEB", "userAgent": "Mozilla/5.0 (iPad)" }, "options": { "build": "latest", "diskMbytes": 2048, "memoryMbytes": 1024, "timeoutSecs": 300 }, "startedAt": "2019-11-30T07:34:24.202Z", "stats": { "computeUnits": 0.0072886, "cpuAvgUsage": 0.00955965, "cpuCurrentUsage": 0, "cpuMaxUsage": 3.1546, "durationMillis": 26239, "inputBodyLen": 240, "memAvgBytes": 35914228.4, "memCurrentBytes": 0, "memMaxBytes": 38244352, "metamorph": 0, "migrationCount": 0, "netRxBytes": 2652, "netTxBytes": 1338, "restartCount": 0, "resurrectCount": 1, "runTimeSecs": 26.239 }, "status": "ABORTED", "statusMessage": "Actor was aborted", "storageIds": { "datasets": { "default": "wmKPijuyDnPZAPRMk" }, "keyValueStores": { "default": "eJNzqsbPiopwJcgGQ" }, "requestQueues": { "default": "FL35cSF7jrxr3BY39" } }, "usage": { "ACTOR_COMPUTE_UNITS": 3, "DATASET_READS": 4, "DATASET_WRITES": 4, "DATA_TRANSFER_EXTERNAL_GBYTES": 3, "DATA_TRANSFER_INTERNAL_GBYTES": 1, "KEY_VALUE_STORE_LISTS": 5, "KEY_VALUE_STORE_READS": 5, "KEY_VALUE_STORE_WRITES": 3, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34, "PROXY_SERPS": 3, "REQUEST_QUEUE_READS": 2, "REQUEST_QUEUE_WRITES": 1 }, "usageTotalUsd": 0.2654, "usageUsd": { "ACTOR_COMPUTE_UNITS": 0.072, "DATASET_READS": 0.0004, "DATASET_WRITES": 0.0002, "DATA_TRANSFER_EXTERNAL_GBYTES": 0.0002, "DATA_TRANSFER_INTERNAL_GBYTES": 0.0004, "KEY_VALUE_STORE_LISTS": 0.004, "KEY_VALUE_STORE_READS": 0.0006, "KEY_VALUE_STORE_WRITES": 0.002, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.16, "PROXY_SERPS": 0.0006, "REQUEST_QUEUE_READS": 0.005, "REQUEST_QUEUE_WRITES": 0.02 }, "userId": "BPWZBd7Z9c746JAng" } }, "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Abort run", "tags": [ "Actors/Actor runs" ], "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": { "deprecated": true, "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": "act_run_metamorph_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/runId" }, { "$ref": "#/components/parameters/targetActorId" }, { "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", "explode": true, "in": "query", "name": "build", "schema": { "example": "beta", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunResponse" } } }, "description": "", "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" } }, "summary": "Metamorph run", "tags": [ "Actors/Actor runs" ], "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/actors/{actorId}/runs/{runId}/resurrect": { "post": { "deprecated": false, "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": "act_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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RunResponse" } ] } } }, "description": "", "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" } }, "summary": "Resurrect run", "tags": [ "Actors/Actor runs" ], "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}/validate-input": { "post": { "deprecated": false, "description": "Validates the provided input against the Actor's input schema for the specified build.\n\nThe endpoint checks whether the JSON payload conforms to the input schema\ndefined in the Actor's build. If no `build` query parameter is provided,\nthe `latest` build tag is used by default.\n", "operationId": "act_validateInput_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "description": "Optional tag or number of the Actor build to use for input schema validation.\nBy default, the `latest` build tag is used.\n", "explode": true, "in": "query", "name": "build", "required": false, "schema": { "example": "latest", "type": "string" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "JSON input to validate against the Actor's input schema.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "valid": { "description": "Whether the input is valid according to the Actor's input schema.", "type": "boolean" } }, "required": [ "valid" ], "type": "object" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Validate Actor input", "tags": [ "Actors" ] } }, "/v2/actors/{actorId}/versions": { "get": { "deprecated": false, "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": "act_versions_get", "parameters": [ { "$ref": "#/components/parameters/actorId" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.1" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitRepoUrl": "https://github.com/jane35/my-actor", "sourceType": "GIT_REPO", "versionNumber": "0.2" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "sourceType": "TARBALL", "tarballUrl": "https://github.com/jane35/my-actor/archive/master.zip", "versionNumber": "0.3" }, { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": null, "gitHubGistUrl": "https://gist.github.com/jane35/e51feb784yu89", "sourceType": "GITHUB_GIST", "versionNumber": "0.4" } ], "total": 5 } }, "schema": { "$ref": "#/components/schemas/ListOfVersionsResponse" } } }, "description": "", "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" } }, "summary": "Get list of versions", "tags": [ "Actors/Actor versions" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "ActorVersionCollectionClientAsync" }, "post": { "deprecated": false, "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": "act_versions_post", "parameters": [ { "$ref": "#/components/parameters/actorId" } ], "requestBody": { "content": { "application/json": { "example": { "gitRepoUrl": "https://github.com/my-github-account/actor-repo", "sourceType": "GIT_REPO", "versionNumber": "0.1" }, "schema": { "$ref": "#/components/schemas/CreateOrUpdateVersionRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/versions/0.0", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create version", "tags": [ "Actors/Actor versions" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionCollectionClientAsync#create", "x-py-name": "create", "x-py-parent": "ActorVersionCollectionClientAsync" } }, "/v2/actors/{actorId}/versions/{versionNumber}": { "delete": { "deprecated": false, "description": "Deletes a specific version of Actor's source code.\n", "operationId": "act_version_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" } ], "responses": { "204": { "content": { "application/json": { "example": {}, "schema": { "example": {}, "type": "object" } } }, "description": "", "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" } }, "summary": "Delete version", "tags": [ "Actors/Actor versions" ], "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" ] }, "get": { "deprecated": false, "description": "Gets a [Version object](#/reference/actors/version-object) that contains all the details about a specific version of an Actor.\n", "operationId": "act_version_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } }, "description": "", "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" } }, "summary": "Get version", "tags": [ "Actors/Actor versions" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#get", "x-py-name": "get", "x-py-parent": "ActorVersionClientAsync" }, "post": { "deprecated": false, "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": "act_version_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" } ], "requestBody": { "content": { "application/json": { "example": { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": [ { "isSecret": false, "name": "DOMAIN", "value": "http://example.com" }, { "isSecret": true, "name": "SECRET_PASSWORD", "value": "MyTopSecretPassword123" } ], "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.0" }, "schema": { "$ref": "#/components/schemas/CreateOrUpdateVersionRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update version (POST)", "tags": [ "Actors/Actor versions" ], "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" ], "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#update", "x-py-name": "update", "x-py-parent": "ActorVersionClientAsync" }, "put": { "deprecated": false, "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": "act_version_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" } ], "requestBody": { "content": { "application/json": { "example": { "applyEnvVarsToBuild": false, "buildTag": "latest", "envVars": [ { "isSecret": false, "name": "DOMAIN", "value": "http://example.com" }, { "isSecret": true, "name": "SECRET_PASSWORD", "value": "MyTopSecretPassword123" } ], "sourceFiles": [], "sourceType": "SOURCE_FILES", "versionNumber": "0.0" }, "schema": { "$ref": "#/components/schemas/CreateOrUpdateVersionRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update version", "tags": [ "Actors/Actor versions" ], "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" ], "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorVersionClientAsync#update", "x-py-name": "update", "x-py-parent": "ActorVersionClientAsync" } }, "/v2/actors/{actorId}/versions/{versionNumber}/env-vars": { "get": { "deprecated": false, "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": "act_version_envVars_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfEnvVarsResponse" } } }, "description": "", "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" } }, "summary": "Get list of environment variables", "tags": [ "Actors/Actor versions" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "ActorEnvVarCollectionClientAsync" }, "post": { "deprecated": false, "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": "act_version_envVars_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" } ], "requestBody": { "content": { "application/json": { "example": { "name": "ENV_VAR_NAME", "value": "my-env-var" }, "schema": { "$ref": "#/components/schemas/EnvVarRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "isSecret": false, "name": "MY_ENV_VAR", "value": "my-value" } }, "schema": { "$ref": "#/components/schemas/EnvVarResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/actors/zdc3Pyhyz3m8vjDeM/versions/1.0/env-vars/ENV_VAR_NAME", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create environment variable", "tags": [ "Actors/Actor versions" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarCollectionClientAsync#create", "x-py-name": "create", "x-py-parent": "ActorEnvVarCollectionClientAsync" } }, "/v2/actors/{actorId}/versions/{versionNumber}/env-vars/{envVarName}": { "delete": { "deprecated": false, "description": "Deletes a specific environment variable.", "operationId": "act_version_envVar_delete", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" }, { "description": "The name of the environment variable", "in": "path", "name": "envVarName", "required": true, "schema": { "example": "MY_ENV_VAR", "type": "string" }, "style": "simple" } ], "responses": { "204": { "content": { "application/json": { "example": {}, "schema": { "example": {}, "type": "object" } } }, "description": "", "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" } }, "summary": "Delete environment variable", "tags": [ "Actors/Actor versions" ], "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" ] }, "get": { "deprecated": false, "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": "act_version_envVar_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" }, { "description": "The name of the environment variable", "in": "path", "name": "envVarName", "required": true, "schema": { "example": "MY_ENV_VAR", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "isSecret": false, "name": "MY_ENV_VAR", "value": "my-value" } }, "schema": { "$ref": "#/components/schemas/EnvVarResponse" } } }, "description": "", "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" } }, "summary": "Get environment variable", "tags": [ "Actors/Actor versions" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#get", "x-py-name": "get", "x-py-parent": "ActorEnvVarClientAsync" }, "post": { "deprecated": false, "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": "act_version_envVar_post", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" }, { "description": "The name of the environment variable", "in": "path", "name": "envVarName", "required": true, "schema": { "example": "MY_ENV_VAR", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "example": { "isSecret": false, "name": "MY_ENV_VAR", "value": "my-new-value" }, "schema": { "$ref": "#/components/schemas/EnvVarRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "isSecret": false, "name": "MY_ENV_VAR", "value": "my-value" } }, "schema": { "$ref": "#/components/schemas/EnvVarResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update environment variable (POST)", "tags": [ "Actors/Actor versions" ], "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" ], "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update", "x-py-name": "update", "x-py-parent": "ActorEnvVarClientAsync" }, "put": { "deprecated": false, "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": "act_version_envVar_put", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/versionNumber" }, { "description": "The name of the environment variable", "in": "path", "name": "envVarName", "required": true, "schema": { "example": "MY_ENV_VAR", "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "example": { "isSecret": false, "name": "MY_ENV_VAR", "value": "my-new-value" }, "schema": { "$ref": "#/components/schemas/EnvVarRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "isSecret": false, "name": "MY_ENV_VAR", "value": "my-value" } }, "schema": { "$ref": "#/components/schemas/EnvVarResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update environment variable", "tags": [ "Actors/Actor versions" ], "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" ], "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ActorEnvVarClientAsync#update", "x-py-name": "update", "x-py-parent": "ActorEnvVarClientAsync" } }, "/v2/actors/{actorId}/webhooks": { "get": { "deprecated": false, "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": "act_webhooks_get", "parameters": [ { "$ref": "#/components/parameters/actorId" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/descCreatedAt" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfWebhooksResponse" } } }, "description": "", "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" } }, "summary": "Get list of webhooks", "tags": [ "Actors/Webhook collection" ], "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/browser-info": { "delete": { "deprecated": false, "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", "operationId": "tools_browser_info_delete", "parameters": [ { "description": "If `true` or `1`, the response omits the `headers` field.", "in": "query", "name": "skipHeaders", "schema": { "type": "boolean" } }, { "description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.", "in": "query", "name": "rawHeaders", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserInfoResponse" } } }, "description": "" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [], "summary": "Get browser info", "tags": [ "Tools" ] }, "get": { "deprecated": false, "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", "operationId": "tools_browser_info_get", "parameters": [ { "description": "If `true` or `1`, the response omits the `headers` field.", "in": "query", "name": "skipHeaders", "schema": { "type": "boolean" } }, { "description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.", "in": "query", "name": "rawHeaders", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserInfoResponse" } } }, "description": "" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [], "summary": "Get browser info", "tags": [ "Tools" ] }, "post": { "deprecated": false, "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", "operationId": "tools_browser_info_post", "parameters": [ { "description": "If `true` or `1`, the response omits the `headers` field.", "in": "query", "name": "skipHeaders", "schema": { "type": "boolean" } }, { "description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.", "in": "query", "name": "rawHeaders", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserInfoResponse" } } }, "description": "" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [], "summary": "Get browser info", "tags": [ "Tools" ] }, "put": { "deprecated": false, "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", "operationId": "tools_browser_info_put", "parameters": [ { "description": "If `true` or `1`, the response omits the `headers` field.", "in": "query", "name": "skipHeaders", "schema": { "type": "boolean" } }, { "description": "If `true` or `1`, the response includes the `rawHeaders` field with the raw request headers.", "in": "query", "name": "rawHeaders", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowserInfoResponse" } } }, "description": "" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [], "summary": "Get browser info", "tags": [ "Tools" ] } }, "/v2/datasets": { "get": { "deprecated": false, "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" }, { "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", "explode": true, "in": "query", "name": "ownership", "schema": { "$ref": "#/components/schemas/StorageOwnership" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfDatasetsResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of datasets", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetCollectionClient#list", "x-js-name": "list", "x-js-parent": "DatasetCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "DatasetCollectionClientAsync" }, "post": { "deprecated": false, "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": [ { "description": "Custom unique name to easily identify the dataset in the future.", "explode": true, "in": "query", "name": "name", "schema": { "example": "eshop-items", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "Returns the existing dataset object if a dataset with the given name already exists." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create dataset", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetCollectionClient#getOrCreate", "x-js-name": "getOrCreate", "x-js-parent": "DatasetCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetCollectionClientAsync#get_or_create", "x-py-name": "get_or_create", "x-py-parent": "DatasetCollectionClientAsync" } }, "/v2/datasets/{datasetId}": { "delete": { "deprecated": false, "description": "Deletes a specific dataset.", "operationId": "dataset_delete", "parameters": [ { "$ref": "#/components/parameters/datasetId" } ], "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" } }, "summary": "Delete dataset", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#delete", "x-js-name": "delete", "x-js-parent": "DatasetClient", "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" ] }, "get": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/datasetId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" } }, "summary": "Get dataset", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#get", "x-js-name": "get", "x-js-parent": "DatasetClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#get", "x-py-name": "get", "x-py-parent": "DatasetClientAsync" }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/datasetId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatasetRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update dataset", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#update", "x-js-name": "update", "x-js-parent": "DatasetClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#update", "x-py-name": "update", "x-py-parent": "DatasetClientAsync" } }, "/v2/datasets/{datasetId}/items": { "get": { "deprecated": false, "description": "Returns data stored in the dataset in a desired format.\n\n### Response format\n\nThe format of the response depends on <code>format</code> query parameter.\n\nThe <code>format</code> parameter can have one of the following values:\n<code>json</code>, <code>jsonl</code>, <code>xml</code>, <code>html</code>,\n<code>csv</code>, <code>xlsx</code> and <code>rss</code>.\n\nThe following table describes how each format is treated.\n\n<table>\n <tr>\n <th>Format</th>\n <th>Items</th>\n </tr>\n <tr>\n <td><code>json</code></td>\n <td rowspan=\"3\">The response is a JSON, JSONL or XML array of raw item objects.</td>\n </tr>\n <tr>\n <td><code>jsonl</code></td>\n </tr>\n <tr>\n <td><code>xml</code></td>\n </tr>\n <tr>\n <td><code>html</code></td>\n <td rowspan=\"3\">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.</td>\n </tr>\n <tr>\n <td><code>csv</code></td>\n </tr>\n <tr>\n <td><code>xlsx</code></td>\n </tr>\n <tr>\n <td><code>rss</code></td>\n <td colspan=\"2\">The response is a RSS file. Each item is displayed as child elements of one\n <code><item></code>.</td>\n </tr>\n</table>\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```\n<name>Paul Newman</name>\n<address>\n <type>home</type>\n <street>21st</street>\n <city>Chicago</city>\n</address>\n<address>\n <type>office</type>\n <street/>\n <city/>\n</address>\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<address type=\"home\">\n <street>21st</street>\n <city>Chicago</city>\n</address>\n<address type=\"office\">unknown</address>\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 `<items>` element and each page object is wrapped in a `<item>` element.\nYou can change this using <code>xmlRoot</code> and <code>xmlRow</code> 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 <code>unwind</code> 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", "parameters": [ { "$ref": "#/components/parameters/datasetId" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/clean" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/datasetParameters_limit" }, { "$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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "example": [ { "foo": "bar" }, { "foo2": "bar2" } ], "items": { "type": "object" }, "type": "array" } }, "application/jsonl": { "example": "{\"foo\":\"bar\"}\\n{\"foo2\":\"bar2\"}\\n", "schema": { "type": "string" } }, "application/rss+xml": { "example": "<rss><channel><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></channel></rss>", "schema": { "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string" } }, "application/xml": { "example": "<items><item><foo>bar</foo></item><item><foo2>bar2</foo2></item></items>", "schema": { "type": "string" } }, "text/csv": { "example": "foo,bar\\nfoo2,bar2\\n", "schema": { "type": "string" } }, "text/html": { "example": "<table><tr><th>foo</th><th>bar</th></tr><tr><td>foo</td><td>bar</td></tr><tr><td>foo2</td><td>bar2</td></tr></table>", "schema": { "type": "string" } } }, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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" } }, "summary": "Get dataset items", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#listItems", "x-js-name": "listItems", "x-js-parent": "DatasetClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#stream_items", "x-py-name": "stream_items", "x-py-parent": "DatasetClientAsync" }, "head": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/datasetId" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/clean" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/datasetParameters_limit" }, { "$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" } ], "responses": { "200": { "content": {}, "description": "", "headers": { "X-Apify-Pagination-Count": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The number of items returned in the current page." }, "X-Apify-Pagination-Limit": { "content": { "text/plain": { "example": "100", "schema": { "type": "string" } } }, "description": "The maximum number of items returned per page." }, "X-Apify-Pagination-Offset": { "content": { "text/plain": { "example": "0", "schema": { "type": "string" } } }, "description": "The offset of the first item in the current page." }, "X-Apify-Pagination-Total": { "content": { "text/plain": { "example": "10204", "schema": { "type": "string" } } }, "description": "The total number of items in the dataset." } } }, "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" } }, "summary": "Get dataset items headers", "tags": [ "Storage/Datasets" ] }, "post": { "deprecated": false, "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", "operationId": "dataset_items_post", "parameters": [ { "$ref": "#/components/parameters/datasetId" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "oneOf": [ { "$ref": "#/components/schemas/PutItemsRequest" }, { "items": { "$ref": "#/components/schemas/PutItemsRequest" }, "type": "array" } ] } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "example": {}, "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items", "schema": { "type": "string" } } } } } }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PutItemResponseError" }, { "$ref": "#/components/schemas/ErrorResponse" } ] } } }, "description": "", "headers": {} }, "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" } }, "summary": "Store items", "tags": [ "Storage/Datasets" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/DatasetClient#pushItems", "x-js-name": "pushItems", "x-js-parent": "DatasetClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/DatasetClientAsync#push_items", "x-py-name": "push_items", "x-py-parent": "DatasetClientAsync" } }, "/v2/datasets/{datasetId}/statistics": { "get": { "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetStatisticsResponse" } } }, "description": "" }, "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" } }, "summary": "Get dataset statistics", "tags": [ "Storage/Datasets" ] } }, "/v2/key-value-stores": { "get": { "deprecated": false, "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" }, { "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", "explode": true, "in": "query", "name": "ownership", "schema": { "$ref": "#/components/schemas/StorageOwnership" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfKeyValueStoresResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of key-value stores", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreCollectionClient#list", "x-js-name": "list", "x-js-parent": "KeyValueStoreCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "KeyValueStoreCollectionClientAsync" }, "post": { "deprecated": false, "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": [ { "description": "Custom unique name to easily identify the store in the future.", "explode": true, "in": "query", "name": "name", "schema": { "example": "eshop-values", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "Returns the existing key-value store object if a store with the given name already exists." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create key-value store", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreCollectionClient#getOrCreate", "x-js-name": "getOrCreate", "x-js-parent": "KeyValueStoreCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreCollectionClientAsync#get_or_create", "x-py-name": "get_or_create", "x-py-parent": "KeyValueStoreCollectionClientAsync" } }, "/v2/key-value-stores/{storeId}": { "delete": { "deprecated": false, "description": "Deletes a key-value store.", "operationId": "keyValueStore_delete", "parameters": [ { "$ref": "#/components/parameters/storeId" } ], "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" } }, "summary": "Delete store", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#delete", "x-js-name": "delete", "x-js-parent": "KeyValueStoreClient", "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" ] }, "get": { "deprecated": false, "description": "Gets an object that contains all the details about a specific key-value\nstore.\n", "operationId": "keyValueStore_get", "parameters": [ { "$ref": "#/components/parameters/storeId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" } }, "summary": "Get store", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#get", "x-js-name": "get", "x-js-parent": "KeyValueStoreClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#get", "x-py-name": "get", "x-py-parent": "KeyValueStoreClientAsync" }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/storeId" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-store-name" }, "schema": { "$ref": "#/components/schemas/UpdateStoreRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyValueStoreResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update store", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#update", "x-js-name": "update", "x-js-parent": "KeyValueStoreClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#update", "x-py-name": "update", "x-py-parent": "KeyValueStoreClientAsync" } }, "/v2/key-value-stores/{storeId}/keys": { "get": { "deprecated": false, "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/keyValueStoreParameters_limit" }, { "$ref": "#/components/parameters/collectionKeys" }, { "$ref": "#/components/parameters/prefixKeys" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfKeysResponse" } } }, "description": "", "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" } }, "summary": "Get list of keys", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#listKeys", "x-js-name": "listKeys", "x-js-parent": "KeyValueStoreClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#list_keys", "x-py-name": "list_keys", "x-py-parent": "KeyValueStoreClientAsync" } }, "/v2/key-value-stores/{storeId}/records": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "A ZIP archive containing the requested records.", "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" } }, "summary": "Download records", "tags": [ "Storage/Key-value stores" ] } }, "/v2/key-value-stores/{storeId}/records/{recordKey}": { "delete": { "deprecated": false, "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" } ], "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" } }, "summary": "Delete record", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#deleteRecord", "x-js-name": "deleteRecord", "x-js-parent": "KeyValueStoreClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#delete_record", "x-py-name": "delete_record", "x-py-parent": "KeyValueStoreClientAsync" }, "get": { "deprecated": false, "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/keyValueStoreParameters_attachment" }, { "$ref": "#/components/parameters/signature" } ], "responses": { "200": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/RecordResponse" } } }, "description": "", "headers": {} }, "302": { "content": {}, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://apifier-key-value-store-prod.s3.amazonaws.com/tqx6jeMia43gYY6eE/INPUT?AWSAccessKeyId=NKDOUN&Expires=1502720992&Signature=DKLVPI4lDDKC", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Get record", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#getRecord", "x-js-name": "getRecord", "x-js-parent": "KeyValueStoreClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#get_record", "x-py-name": "get_record", "x-py-parent": "KeyValueStoreClientAsync" }, "head": { "deprecated": false, "description": "Check if a value is stored in the key-value store under a specific key.\n", "operationId": "keyValueStore_record_head", "parameters": [ { "$ref": "#/components/parameters/storeId" }, { "$ref": "#/components/parameters/recordKey" } ], "responses": { "200": { "description": "The record exists", "headers": {} }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Check if a record exists", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#recordExists", "x-js-name": "recordExists", "x-js-parent": "KeyValueStoreClient", "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#record_exists", "x-py-name": "record_exists", "x-py-parent": "KeyValueStoreClientAsync" }, "post": { "deprecated": false, "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" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record (POST)", "tags": [ "Storage/Key-value stores" ], "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" ] }, "put": { "deprecated": false, "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* Gzip compression: `Content-Encoding: gzip`\n* Deflate compression: `Content-Encoding: deflate`\n* Brotli compression: `Content-Encoding: br`\n", "operationId": "keyValueStore_record_put", "parameters": [ { "$ref": "#/components/parameters/storeId" }, { "$ref": "#/components/parameters/recordKey" }, { "$ref": "#/components/parameters/Content-Encoding" } ], "requestBody": { "content": { "*/*": { "schema": {} }, "application/json": { "schema": { "$ref": "#/components/schemas/PutRecordRequest" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Store record", "tags": [ "Storage/Key-value stores" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/KeyValueStoreClient#setRecord", "x-js-name": "setRecord", "x-js-parent": "KeyValueStoreClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/KeyValueStoreClientAsync#set_record", "x-py-name": "set_record", "x-py-parent": "KeyValueStoreClientAsync" } }, "/v2/logs/{buildOrRunId}": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "text/plain": { "schema": { "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", "type": "string" } } }, "description": "", "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" } }, "security": [ { "httpBearer": [] }, { "apiKey": [] }, {} ], "summary": "Get log", "tags": [ "Logs" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/LogClient#stream", "x-js-name": "stream", "x-js-parent": "LogClient", "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" ], "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/LogClientAsync#stream", "x-py-name": "stream", "x-py-parent": "LogClientAsync" } }, "/v2/request-queues": { "get": { "deprecated": false, "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" }, { "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", "explode": true, "in": "query", "name": "ownership", "schema": { "$ref": "#/components/schemas/StorageOwnership" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfRequestQueuesResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of request queues", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueCollectionClient#list", "x-js-name": "list", "x-js-parent": "RequestQueueCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "RequestQueueCollectionClientAsync" }, "post": { "deprecated": false, "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": [ { "description": "Custom unique name to easily identify the queue in the future.", "explode": true, "in": "query", "name": "name", "required": false, "schema": { "example": "example-com", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "Returns the existing request queue object if a queue with the given name already exists." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/request-queues/WkzbQMuFYuamGv3YF", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create request queue", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueCollectionClient#getOrCreate", "x-js-name": "getOrCreate", "x-js-parent": "RequestQueueCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueCollectionClientAsync#get_or_create", "x-py-name": "get_or_create", "x-py-parent": "RequestQueueCollectionClientAsync" } }, "/v2/request-queues/{queueId}": { "delete": { "deprecated": false, "description": "Deletes given queue.", "operationId": "requestQueue_delete", "parameters": [ { "$ref": "#/components/parameters/queueId" } ], "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" } }, "summary": "Delete request queue", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#delete", "x-js-name": "delete", "x-js-parent": "RequestQueueClient", "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" ] }, "get": { "deprecated": false, "description": "Returns queue object for given queue ID.", "operationId": "requestQueue_get", "parameters": [ { "$ref": "#/components/parameters/queueId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" } }, "summary": "Get request queue", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#get", "x-js-name": "get", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get", "x-py-name": "get", "x-py-parent": "RequestQueueClientAsync" }, "put": { "deprecated": false, "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", "parameters": [ { "$ref": "#/components/parameters/queueId" } ], "requestBody": { "content": { "application/json": { "example": { "name": "new-request-queue-name" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateRequestQueueRequest" }, { "example": { "name": "new-request-queue-name" } } ] } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestQueueResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update request queue", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#update", "x-js-name": "update", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update", "x-py-name": "update", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/head": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadResponse" } } }, "description": "", "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" } }, "summary": "Get head", "tags": [ "Storage/Request queues/Requests locks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#listHead", "x-js-name": "listHead", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_head", "x-py-name": "list_head", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/head/lock": { "post": { "deprecated": false, "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" } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeadAndLockResponse" } } }, "description": "", "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" } }, "summary": "Get head and lock", "tags": [ "Storage/Request queues/Requests locks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#listAndLockHead", "x-js-name": "listAndLockHead", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_and_lock_head", "x-py-name": "list_and_lock_head", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/requests": { "get": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfRequestsResponse" } } }, "description": "", "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" } }, "summary": "List requests", "tags": [ "Storage/Request queues/Requests" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#paginateRequests", "x-js-name": "paginateRequests", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#list_requests", "x-py-name": "list_requests", "x-py-parent": "RequestQueueClientAsync" }, "post": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBase" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Add request", "tags": [ "Storage/Request queues/Requests" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#addRequest", "x-js-name": "addRequest", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#add_request", "x-py-name": "add_request", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/requests/batch": { "delete": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RequestDraftDelete" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDeleteResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Delete requests", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchDeleteRequests", "x-js-name": "batchDeleteRequests", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_delete_requests", "x-py-name": "batch_delete_requests", "x-py-parent": "RequestQueueClientAsync" }, "post": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "items": { "$ref": "#/components/schemas/RequestBase" }, "type": "array" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchAddResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Add requests", "tags": [ "Storage/Request queues" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#batchAddRequests", "x-js-name": "batchAddRequests", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#batch_add_requests", "x-py-name": "batch_add_requests", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/requests/unlock": { "post": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlockRequestsResponse" } } }, "description": "Number of requests that were unlocked" }, "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" } }, "summary": "Unlock requests", "tags": [ "Storage/Request queues/Requests locks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#unlockRequests", "x-js-name": "unlockRequests", "x-js-parent": "RequestQueueClient", "x-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#unlock_requests", "x-py-name": "unlock_requests", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/requests/{requestId}": { "delete": { "deprecated": false, "description": "Deletes given request from queue.", "operationId": "requestQueue_request_delete", "parameters": [ { "$ref": "#/components/parameters/queueId" }, { "$ref": "#/components/parameters/requestId" }, { "$ref": "#/components/parameters/clientKey" } ], "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" } }, "summary": "Delete request", "tags": [ "Storage/Request queues/Requests" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#delete", "x-js-name": "delete", "x-js-parent": "RequestQueueClient", "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" ] }, "get": { "deprecated": false, "description": "Returns request from queue.", "operationId": "requestQueue_request_get", "parameters": [ { "$ref": "#/components/parameters/queueId" }, { "$ref": "#/components/parameters/requestId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestResponse" } } }, "description": "", "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" } }, "summary": "Get request", "tags": [ "Storage/Request queues/Requests" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#get", "x-js-name": "get", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#get", "x-py-name": "get", "x-py-parent": "RequestQueueClientAsync" }, "put": { "deprecated": false, "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequestResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update request", "tags": [ "Storage/Request queues/Requests" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#update", "x-js-name": "update", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#update", "x-py-name": "update", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/request-queues/{queueId}/requests/{requestId}/lock": { "delete": { "deprecated": false, "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" } ], "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" } }, "summary": "Delete request lock", "tags": [ "Storage/Request queues/Requests locks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#deleteRequestLock", "x-js-name": "deleteRequestLock", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#delete_request_lock", "x-py-name": "delete_request_lock", "x-py-parent": "RequestQueueClientAsync" }, "put": { "deprecated": false, "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" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProlongRequestLockResponse" } } }, "description": "", "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" } }, "summary": "Prolong request lock", "tags": [ "Storage/Request queues/Requests locks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#prolongRequestLock", "x-js-name": "prolongRequestLock", "x-js-parent": "RequestQueueClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#prolong_request_lock", "x-py-name": "prolong_request_lock", "x-py-parent": "RequestQueueClientAsync" } }, "/v2/schedules": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfSchedulesResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of schedules", "tags": [ "Schedules" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleCollectionClient#list", "x-js-name": "list", "x-js-parent": "ScheduleCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "ScheduleCollectionClientAsync" }, "post": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreate" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/schedules/asdLZtadYvn4mBZmm", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create schedule", "tags": [ "Schedules" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleCollectionClient#create", "x-js-name": "create", "x-js-parent": "ScheduleCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleCollectionClientAsync#create", "x-py-name": "create", "x-py-parent": "ScheduleCollectionClientAsync" } }, "/v2/schedules/{scheduleId}": { "delete": { "deprecated": false, "description": "Deletes a schedule.", "operationId": "schedule_delete", "parameters": [ { "$ref": "#/components/parameters/scheduleId" } ], "responses": { "204": { "content": { "application/json": { "example": {}, "schema": { "example": {}, "type": "object" } } }, "description": "", "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" } }, "summary": "Delete schedule", "tags": [ "Schedules" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#delete", "x-js-name": "delete", "x-js-parent": "ScheduleClient", "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" ] }, "get": { "deprecated": false, "description": "Gets the schedule object with all details.", "operationId": "schedule_get", "parameters": [ { "$ref": "#/components/parameters/scheduleId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "", "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" } }, "summary": "Get schedule", "tags": [ "Schedules" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#get", "x-js-name": "get", "x-js-parent": "ScheduleClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#get", "x-py-name": "get", "x-py-parent": "ScheduleClientAsync" }, "put": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreate" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update schedule", "tags": [ "Schedules" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#update", "x-js-name": "update", "x-js-parent": "ScheduleClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#update", "x-py-name": "update", "x-py-parent": "ScheduleClientAsync" } }, "/v2/schedules/{scheduleId}/log": { "get": { "deprecated": false, "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": { "content": { "application/json": { "example": { "data": [ { "createdAt": "2019-03-26T12:28:00.370Z", "level": "INFO", "message": "Schedule invoked" }, { "createdAt": "2019-03-26T12:30:00.325Z", "level": "ERROR", "message": "Cannot start Actor task \\\"iEvfA6pm6DWjRTGxS\\\": Provided input must be object, got \\\"string\\\" instead." } ] }, "schema": { "$ref": "#/components/schemas/ScheduleLogResponse" } } }, "description": "", "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" } }, "summary": "Get schedule log", "tags": [ "Schedules" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/ScheduleClient#getLog", "x-js-name": "getLog", "x-js-parent": "ScheduleClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/ScheduleClientAsync#get_log", "x-py-name": "get_log", "x-py-parent": "ScheduleClientAsync" } }, "/v2/store": { "get": { "deprecated": false, "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" }, { "description": "String to search by. The search runs on the following fields: `title`,\n`name`, `description`, `username`, `readme`.\n", "explode": true, "in": "query", "name": "search", "schema": { "example": "web scraper", "type": "string" }, "style": "form" }, { "description": "Specifies the field by which to sort the results. The supported values\nare `relevance` (default), `popularity`, `newest` and `lastUpdate`.\n", "explode": true, "in": "query", "name": "sortBy", "schema": { "example": "'popularity'", "type": "string" }, "style": "form" }, { "description": "Filters the results by the specified category.", "explode": true, "in": "query", "name": "category", "schema": { "example": "'AI'", "type": "string" }, "style": "form" }, { "description": "Filters the results by the specified username.", "explode": true, "in": "query", "name": "username", "schema": { "example": "'apify'", "type": "string" }, "style": "form" }, { "description": "Only return Actors with the specified pricing model.\n", "explode": true, "in": "query", "name": "pricingModel", "schema": { "enum": [ "FREE", "FLAT_PRICE_PER_MONTH", "PRICE_PER_DATASET_ITEM", "PAY_PER_EVENT" ], "example": "FREE", "type": "string" }, "style": "form" }, { "description": "If true, only return Actors that allow agentic users. If false, only\nreturn Actors that do not allow agentic users.\n", "explode": true, "in": "query", "name": "allowsAgenticUsers", "schema": { "example": true, "type": "boolean" }, "style": "form" }, { "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", "explode": true, "in": "query", "name": "responseFormat", "schema": { "default": "full", "enum": [ "full", "agent" ], "example": "agent", "type": "string" }, "style": "form" }, { "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", "explode": true, "in": "query", "name": "includeUnrunnableActors", "schema": { "default": false, "example": true, "type": "boolean" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfActorsInStoreResponse" } } }, "description": "", "headers": {} }, "400": { "$ref": "#/components/responses/BadRequest" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Get list of Actors in Store", "tags": [ "Store" ], "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/tools/decode-and-verify": { "post": { "deprecated": false, "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", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeAndVerifyRequest" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecodeAndVerifyResponse" } } }, "description": "" }, "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" } }, "security": [], "summary": "Decode and verify object", "tags": [ "Tools" ] } }, "/v2/tools/encode-and-sign": { "post": { "deprecated": false, "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": { "content": { "application/json": { "example": { "key": "value" }, "schema": { "type": "object" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncodeAndSignResponse" } } }, "description": "" }, "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" } }, "summary": "Encode and sign object", "tags": [ "Tools" ] } }, "/v2/users/me": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateUserDataResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get private user data", "tags": [ "Users" ], "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/limits": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LimitsResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get limits", "tags": [ "Users" ], "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": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLimitsRequest" } } }, "description": "" }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Update limits", "tags": [ "Users" ], "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/users/me/usage/monthly": { "get": { "deprecated": false, "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": [ { "description": "Date in the YYYY-MM-DD format.", "explode": true, "in": "query", "name": "date", "schema": { "example": "2020-06-14", "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyUsageResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get monthly usage", "tags": [ "Users" ], "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/{userId}": { "get": { "deprecated": false, "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": [ { "description": "User ID or username.", "in": "path", "name": "userId", "required": true, "schema": { "example": "HGzIk8z78YcAPEB", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUserDataResponse" } } }, "description": "", "headers": {} }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Get public user data", "tags": [ "Users" ], "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/webhook-dispatches": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfWebhookDispatchesResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of webhook dispatches", "tags": [ "Webhooks/Webhook dispatches" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookDispatchCollectionClient#list", "x-js-name": "list", "x-js-parent": "WebhookDispatchCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookDispatchCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "WebhookDispatchCollectionClientAsync" } }, "/v2/webhook-dispatches/{dispatchId}": { "get": { "deprecated": false, "description": "Gets webhook dispatch object with all details.", "operationId": "webhookDispatch_get", "parameters": [ { "description": "Webhook dispatch ID.", "in": "path", "name": "dispatchId", "required": true, "schema": { "example": "Zib4xbZsmvZeK55ua", "type": "string" }, "style": "simple" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDispatchResponse" } } }, "description": "", "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" } }, "summary": "Get webhook dispatch", "tags": [ "Webhooks/Webhook dispatches" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookDispatchClient#get", "x-js-name": "get", "x-js-parent": "WebhookDispatchClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookDispatchClientAsync#get", "x-py-name": "get", "x-py-parent": "WebhookDispatchClientAsync" } }, "/v2/webhooks": { "get": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfWebhooksResponse" } } }, "description": "", "headers": {} }, "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" } }, "summary": "Get list of webhooks", "tags": [ "Webhooks/Webhooks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookCollectionClient#list", "x-js-name": "list", "x-js-parent": "WebhookCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClientAsync#list", "x-py-name": "list", "x-py-parent": "WebhookCollectionClientAsync" }, "post": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } }, "description": "", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } }, "description": "", "headers": { "Location": { "content": { "text/plain": { "example": "https://api.apify.com/v2/webhook/zdc3Pyhyz3m8vjDeM", "schema": { "type": "string" } } } } } }, "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" } }, "summary": "Create webhook", "tags": [ "Webhooks/Webhooks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookCollectionClient#create", "x-js-name": "create", "x-js-parent": "WebhookCollectionClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookCollectionClientAsync#create", "x-py-name": "create", "x-py-parent": "WebhookCollectionClientAsync" } }, "/v2/webhooks/{webhookId}": { "delete": { "deprecated": false, "description": "Deletes a webhook.", "operationId": "webhook_delete", "parameters": [ { "$ref": "#/components/parameters/webhookId" } ], "responses": { "204": { "content": { "application/json": { "example": {}, "schema": { "type": "object" } } }, "description": "", "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" } }, "summary": "Delete webhook", "tags": [ "Webhooks/Webhooks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#delete", "x-js-name": "delete", "x-js-parent": "WebhookClient", "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" ] }, "get": { "deprecated": false, "description": "Gets webhook object with all details.", "operationId": "webhook_get", "parameters": [ { "$ref": "#/components/parameters/webhookId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } }, "description": "", "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" } }, "summary": "Get webhook", "tags": [ "Webhooks/Webhooks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#get", "x-js-name": "get", "x-js-parent": "WebhookClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#get", "x-py-name": "get", "x-py-parent": "WebhookClientAsync" }, "put": { "deprecated": false, "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": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdate" } } }, "description": "", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" } } }, "description": "", "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" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "summary": "Update webhook", "tags": [ "Webhooks/Webhooks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#update", "x-js-name": "update", "x-js-parent": "WebhookClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#update", "x-py-name": "update", "x-py-parent": "WebhookClientAsync" } }, "/v2/webhooks/{webhookId}/dispatches": { "get": { "deprecated": false, "description": "Gets a given webhook's list of dispatches.", "operationId": "webhook_webhookDispatches_get", "parameters": [ { "$ref": "#/components/parameters/webhookId" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOfWebhookDispatchesResponse" } } }, "description": "", "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" } }, "summary": "Get collection", "tags": [ "Webhooks/Webhooks" ], "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-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#dispatches", "x-py-name": "dispatches", "x-py-parent": "WebhookClientAsync" } }, "/v2/webhooks/{webhookId}/test": { "post": { "deprecated": false, "description": "Tests a webhook. Creates a webhook dispatch with a dummy payload.", "operationId": "webhook_test_post", "parameters": [ { "$ref": "#/components/parameters/webhookId" } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestWebhookResponse" } } }, "description": "", "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" } }, "summary": "Test webhook", "tags": [ "Webhooks/Webhooks" ], "x-js-doc-url": "https://docs.apify.com/api/client/js/reference/class/WebhookClient#test", "x-js-name": "test", "x-js-parent": "WebhookClient", "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-py-doc-url": "https://docs.apify.com/api/client/python/reference/class/WebhookClientAsync#test", "x-py-name": "test", "x-py-parent": "WebhookClientAsync" } } }, "security": [ { "httpBearer": [] }, { "apiKey": [] } ], "servers": [ { "url": "https://api.apify.com", "variables": {} } ], "tags": [ { "description": "The API endpoints in this section allow you to manage Apify Actors. For more details about Actors, refer to the [Actor documentation](https://docs.apify.com/platform/actors).\n\nFor API endpoints that require the `actorId` parameter to identify an Actor, you can provide either:\n- The Actor ID (e.g., `HG7ML7M8z78YcAPEB`), or\n- A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`).\n", "name": "Actors", "x-displayName": "Actors - Introduction", "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 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:<br/> - `name`: File path and name<br/> - `format`: Format of the content, can be either `\"TEXT\"` or `\"BASE64\"`<br/> - `content`: File content<br/><br/>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 versions", "x-displayName": "Actor versions - Introduction", "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-parent-tag-name": "Actors", "x-trait": "true" }, { "description": "The API endpoints in this section allow you to manage your Apify Actors builds.\n", "name": "Actors/Actor builds", "x-displayName": "Actor builds - Introduction", "x-legacy-doc-urls": [ "#/reference/actors/build-collection", "#tag/ActorsBuild-collection", "#/reference/actors/build-object", "#tag/ActorsBuild-object", "#tag/ActorsAbort-build" ], "x-parent-tag-name": "Actors", "x-trait": "true" }, { "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", "name": "Actors/Actor runs", "x-displayName": "Actor runs - Introduction", "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" ], "x-parent-tag-name": "Actors", "x-trait": "true" }, { "description": "The API endpoint in this section allows you to get a list of webhooks of a specific Actor.\n", "name": "Actors/Webhook collection", "x-displayName": "Webhook collection - Introduction", "x-legacy-doc-urls": [ "#/reference/actors/webhook-collection", "#tag/ActorsWebhook-collection" ], "x-parent-tag-name": "Actors", "x-trait": "true" }, { "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 builds", "x-displayName": "Actor builds - Introduction", "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 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 runs", "x-displayName": "Actor runs - Introduction", "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 create, manage, delete, and run Apify Actor tasks.\nFor more information, see the [Actor tasts 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": "Actor tasks", "x-displayName": "Actor tasks - Introduction", "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": "Storage-related API endpoints for managing datasets, key-value stores, and request queues.", "name": "Storage", "x-displayName": "" }, { "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", "name": "Storage/Datasets", "x-displayName": "Datasets - Introduction", "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" ], "x-parent-tag-name": "Storage", "x-trait": "true" }, { "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", "name": "Storage/Key-value stores", "x-displayName": "Key-value stores - Introduction", "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" ], "x-parent-tag-name": "Storage", "x-trait": "true" }, { "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", "x-displayName": "Request queues - Introduction", "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" ], "x-parent-tag-name": "Storage" }, { "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", "x-displayName": "Requests - Introduction", "x-legacy-doc-urls": [ "#/reference/request-queues/request-collection", "#tag/Request-queuesRequest-collection", "#/reference/request-queues/request", "#tag/Request-queuesRequest" ], "x-parent-tag-name": "Storage" }, { "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": "Storage/Request queues/Requests locks", "x-displayName": "Requests locks - Introduction", "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" ], "x-parent-tag-name": "Storage" }, { "description": "Webhook-related API endpoints for configuring automated notifications.", "name": "Webhooks", "x-displayName": "" }, { "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/Webhooks", "x-displayName": "Webhooks - Introduction", "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" ], "x-parent-tag-name": "Webhooks" }, { "description": "This section describes API endpoints to get webhook dispatches.", "name": "Webhooks/Webhook dispatches", "x-displayName": "Webhook dispatches - Introduction", "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" ], "x-parent-tag-name": "Webhooks" }, { "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", "name": "Schedules", "x-displayName": "Schedules - Introduction", "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" ], "x-trait": "true" }, { "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", "name": "Store", "x-displayName": "Store - Introduction", "x-legacy-doc-urls": [ "#/reference/store", "#tag/Store", "#/reference/store/store-actors-collection", "#tag/StoreStore-Actors-collection" ], "x-trait": true }, { "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", "name": "Logs", "x-displayName": "Logs - Introduction", "x-legacy-doc-urls": [ "#/reference/logs", "#tag/Logs", "#/reference/logs/log", "#tag/LogsLog" ], "x-trait": true }, { "description": "The API endpoints described in this section return information about user accounts.", "name": "Users", "x-displayName": "Users - Introduction", "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" ], "x-trait": true }, { "description": "The API endpoints described in this section provide utility tools for encoding,\nsigning, and verifying data, as well as inspecting HTTP request details.\n", "name": "Tools", "x-displayName": "Tools - Introduction" }, { "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 dataset", "x-displayName": "Default dataset - Introduction" }, { "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 key-value store", "x-displayName": "Default key-value store - Introduction" }, { "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": "Default request queue", "x-displayName": "Default request queue - Introduction" }, { "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 dataset", "x-displayName": "Last Actor run's default dataset - Introduction" }, { "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 key-value store", "x-displayName": "Last Actor run's default key-value store - Introduction" }, { "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 default request queue", "x-displayName": "Last Actor run's default request queue - Introduction" }, { "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 log", "x-displayName": "Last Actor run's log - Introduction" }, { "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 abort", "x-displayName": "Last Actor run's abort - Introduction" }, { "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 metamorph", "x-displayName": "Last Actor run's metamorph - Introduction" }, { "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 run's reboot", "x-displayName": "Last Actor run's reboot - Introduction" }, { "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 log", "x-displayName": "Last Actor task run's log - Introduction" }, { "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 abort", "x-displayName": "Last Actor task run's abort - Introduction" }, { "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 metamorph", "x-displayName": "Last Actor task run's metamorph - Introduction" }, { "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 reboot", "x-displayName": "Last Actor task run's reboot - Introduction" }, { "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 dataset", "x-displayName": "Last Actor task run's default dataset - Introduction" }, { "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 key-value store", "x-displayName": "Last Actor task run's default key-value store - Introduction" }, { "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", "name": "Last Actor task run's default request queue", "x-displayName": "Last Actor task run's default request queue - Introduction" } ], "x-tagGroups": [ { "name": "Actors", "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": "Webhooks", "tags": [ "Webhooks/Webhooks", "Webhooks/Webhook dispatches" ] }, { "name": "Schedules", "tags": [ "Schedules" ] }, { "name": "Store", "tags": [ "Store" ] }, { "name": "Logs", "tags": [ "Logs" ] }, { "name": "Users", "tags": [ "Users" ] }, { "name": "Tools", "tags": [ "Tools" ] }, { "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" ] } ] }