Version: Next

CallOptions

Hierarchy

ActorCallOptions
- CallOptions

Index

Properties

build
contentType
maxItems
memory
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).

externaloptionalinheritedcontentType

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.

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.

externaloptionalinheritedtimeout

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.

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.