Skip to main content
Version: Next

CallOptions

Hierarchy

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

externaloptionalinheritedcontentType

contentType?: string

Content type of the request body, which becomes the content type of the run's INPUT record. Without it, an input is serialized to JSON and sent as application/json. Pairing an object with application/x-www-form-urlencoded form-encodes it instead.

externaloptionalinheritedforcePermissionLevel

forcePermissionLevel?: ACTOR_PERMISSION_LEVEL

Override the Actor's permissions for this run. If not set, the Actor will run with permissions configured in the Actor settings.

Added in 2.17.0

externaloptionalinheritedlog

log?: null | Log | default

Log instance that should be used to redirect Actor run logs to. If undefined or 'default' the pre-defined Log will be created and used. If null, no log redirection will occur.

Added in 2.20.0

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.

Added in 2.7.0

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.

Added in 2.9.7

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.

externaloptionalinheritedsignal

signal?: AbortSignal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

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.

externaloptionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.

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

Wait time in seconds for the Actor run to finish.

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