Skip to main content
Version: Next

CallTaskOptions

Hierarchy

  • Omit<TaskCallOptions, timeout>
    • CallTaskOptions

Index

Properties

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 maximum number of items that the actor run should return. This is used by pay per result actors to limit the maximum number of results that will be charged to customer. Value can be accessed in actor run using ACTOR_MAX_PAID_DATASET_ITEMS 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.

optionaltimeout

timeout?: number | inherit

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

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

optionaltoken

token?: string

User API token that is used to run the Actor. 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.

Page Options