Version: Next

CallTaskOptions

Hierarchy

Omit<TaskCallOptions, timeout>
Token
Timeout
- CallTaskOptions

Index

Properties

build
maxItems
maxTotalChargeUsd
memory
restartOnError
timeout
token
waitSecs
webhooks

Properties

externaloptionalinheritedbuild

build?: string

Tag or number of the actor build to run (e.g. beta or 1.2.345). If not provided, the run uses build tag or number from the default actor run configuration (typically latest).

externaloptionalinheritedmaxItems

maxItems?: number

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.

externaloptionalinheritedmaxTotalChargeUsd

maxTotalChargeUsd?: number

Specifies the maximum cost of the Actor run. This parameter is used only for pay-per-event Actors. It allows you to limit the amount charged to your subscription. You can access the maximum cost in your Actor by using the ACTOR_MAX_TOTAL_CHARGE_USD environment variable.

externaloptionalinheritedmemory

memory?: number

Memory in megabytes which will be allocated for the new actor run. If not provided, the run uses memory of the default actor run configuration.

externaloptionalinheritedrestartOnError

restartOnError?: boolean

Determines whether the run will be restarted if it fails.

optionalinheritedtimeout

timeout?: number | inherit

Timeout for the Actor run in seconds, or 'inherit'.

Using inherit will set timeout of the newly started Actor run to the time remaining until this Actor run times out so that the new run does not outlive this one.

optionalinheritedtoken

token?: string

User Apify API token that is used for API calls. By default, it is taken from the APIFY_TOKEN environment variable.

externaloptionalinheritedwaitSecs

waitSecs?: number

externaloptionalinheritedwebhooks

webhooks?: readonly WebhookUpdateData[]

Specifies optional webhooks associated with the actor run, which can be used to receive a notification e.g. when the actor finished or failed, see ad hook webhooks documentation for detailed description.