Skip to main content
Version: 2.9

ActorStartOptions

Index

Properties

Properties

optionalbuild

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

optionalcontentType

contentType?: string

Content type for the input. If not specified, input is expected to be an object that will be stringified to JSON and content type set to application/json; charset=utf-8. If options.contentType is specified, then input must be a String or Buffer.

optionalmaxItems

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.

optionalmemory

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.

optionaltimeout

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.

optionalwaitForFinish

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 waitForFinish is null or undefined, the function waits for the actor to finish (default behavior).

optionalwebhooks

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.