Version: 3.0

CallTaskOptions

Hierarchy

TaskStartOptions
- CallTaskOptions

Index

Properties

build
memory
timeout
token
waitForFinish
webhooks

Properties

externaloptionalbuild

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).

externaloptionalmemory

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.

externaloptionaltimeout

timeout?: number

Timeout for the actor run in seconds. Zero value means there is no timeout. If not provided, the run uses timeout of the default actor run configuration.

optionaltoken

token?: string

User API token that is used to run the actor. By default, it is taken from the APIFY_TOKEN environment variable.

externaloptionalwaitForFinish

waitForFinish?: number

Maximum time to wait for the actor run to finish, in seconds. If the limit is reached, the returned promise is resolved to a run object that will have status READY or RUNNING and it will not contain the actor run output. If waitSecs is null or undefined, the function waits for the actor to finish (default behavior).

externaloptionalwebhooks

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.