Run task
Runs an Actor task and immediately returns without waiting for the run to finish.
Optionally, you can override the Actor input configuration by passing a JSON object as the POST payload and setting the Content-Type: application/json HTTP header.
Note that if the object in the POST payload does not define a particular input property, the Actor run uses the default value defined by the task (or Actor's input schema if not defined by the task).
The response is the Actor Run object as returned by the Get run endpoint.
If you want to wait for the run to finish and receive the actual output of the Actor run as the response, use one of the Run task synchronously API endpoints instead.
To fetch the Actor run results that are typically stored in the default dataset, you'll need to pass the ID received in the defaultDatasetId field received in the response JSON to the Get dataset items API endpoint.
Path parameters
Task ID or a tilde-separated owner's username and task's name.
Query parameters
Optional timeout for the run, in seconds. By default, the run uses the timeout from its configuration.
Memory limit for the run, in megabytes. You can set the amount of memory to a power of 2 with a minimum of 128. By default, the run uses the memory limit from its configuration. Don't change this value unless the Actor's documentation recommends it or you're aware of the consequences.
Specifies the maximum number of dataset items that will be charged for pay-per-result Actors. This does NOT guarantee that the Actor will return only this many items. It only ensures you won't be charged for more than this number of items. Only works for pay-per-result Actors. Value can be accessed in the actor run using ACTOR_MAX_PAID_DATASET_ITEMS environment variable.
Specifies the maximum total cost of the run. Use it to cap the total amount charged for all pricing models. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.
Determines whether the run will be restarted if it fails.
Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build from its configuration (typically latest).
The maximum number of seconds the server waits for the run to finish. By default it is 0, the maximum value is 60. <!-- MAX_ACTOR_JOB_ASYNC_WAIT_SECS --> If the run finishes in time then the returned run object will have a terminal status (e.g. SUCCEEDED), otherwise it will have a transitional status (e.g. RUNNING).
Specifies optional webhooks associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed. The value is a Base64-encoded JSON array whose items follow the WebhookRepresentation schema. For more information, see Webhooks documentation.
Request body
Response
Example response
{
"data": {
"id": "HG7ML7M8z78YcAPEB",
"actId": "HDSasDasz78YcAPEB",
"userId": "7sT5jcggjjA9fNcxF",
"actorTaskId": "KJHSKHausidyaJKHs",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"statusMessage": "Actor is running",
"stats": {
"inputBodyLen": 240,
"resurrectCount": 2,
"memAvgBytes": 267874071.9,
"memMaxBytes": 404713472,
"cpuAvgUsage": 33.7532101107538,
"cpuMaxUsage": 169.650735534941,
"netRxBytes": 103508042,
"netTxBytes": 4854600,
"durationMillis": 248472,
"runTimeSecs": 248.472,
"computeUnits": 0.13804
},
"chargedEventCounts": {
"actor-start": 1,
"page-crawled": 150,
"data-extracted": 75
},
"options": {
"build": "latest",
"timeoutSecs": 300,
"memoryMbytes": 1024,
"diskMbytes": 2048,
"maxItems": 1000,
"maxTotalChargeUsd": 5
},
"buildId": "7sT5jcggjjA9fNcxF",
"generalAccess": "RESTRICTED",
"defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
"defaultDatasetId": "wmKPijuyDnPZAPRMk",
"defaultRequestQueueId": "FL35cSF7jrxr3BY39",
"storageIds": {
"datasets": {
"default": "wmKPijuyDnPZAPRMk"
},
"keyValueStores": {
"default": "eJNzqsbPiopwJcgGQ"
},
"requestQueues": {
"default": "FL35cSF7jrxr3BY39"
}
},
"buildNumber": "0.0.36",
"containerUrl": "https://g8kd8kbc5ge8.runs.apify.net",
"isContainerServerReady": true,
"gitBranchName": "master",
"usage": {
"ACTOR_COMPUTE_UNITS": 3,
"DATASET_READS": 4,
"DATASET_WRITES": 4,
"KEY_VALUE_STORE_READS": 5,
"KEY_VALUE_STORE_WRITES": 3,
"KEY_VALUE_STORE_LISTS": 5,
"REQUEST_QUEUE_READS": 2,
"REQUEST_QUEUE_WRITES": 1,
"DATA_TRANSFER_INTERNAL_GBYTES": 1,
"DATA_TRANSFER_EXTERNAL_GBYTES": 3,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
"PROXY_SERPS": 3
},
"usageTotalUsd": 0.2654,
"usageUsd": {
"ACTOR_COMPUTE_UNITS": 0.0003,
"DATASET_READS": 0.0001,
"DATASET_WRITES": 0.0001,
"KEY_VALUE_STORE_READS": 0.0001,
"KEY_VALUE_STORE_WRITES": 0.00005,
"KEY_VALUE_STORE_LISTS": 0.0001,
"REQUEST_QUEUE_READS": 0.0001,
"REQUEST_QUEUE_WRITES": 0.0001,
"DATA_TRANSFER_INTERNAL_GBYTES": 0.001,
"DATA_TRANSFER_EXTERNAL_GBYTES": 0.003,
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.034,
"PROXY_SERPS": 0.003
},
"metamorphs": [
{
"createdAt": "2019-11-30T07:39:24.202Z",
"actorId": "nspoEjklmnsF2oosD",
"buildId": "ME6oKecqy5kXDS4KQ",
"inputKey": "INPUT-METAMORPH-1"
}
],
"platformUsageBillingModel": "USER"
}
}