Skip to main content
Version: 2.5

ActorEnvVars

Environment variables with ACTOR_ prefix set by the Apify platform.

These variables provide essential context about the current Actor run, including identifiers, resource limits, and configuration details. All variables are automatically set by the platform during Actor execution.

Index

Enumeration Members

BUILD_ID

BUILD_ID: 'ACTOR_BUILD_ID'

Unique identifier of the Actor build used for this run.

BUILD_NUMBER

BUILD_NUMBER: 'ACTOR_BUILD_NUMBER'

Sequential build number of the Actor build used for this run.

BUILD_TAGS

BUILD_TAGS: 'ACTOR_BUILD_TAGS'

Comma-separated list of tags associated with the Actor build.

DEFAULT_DATASET_ID

DEFAULT_DATASET_ID: 'ACTOR_DEFAULT_DATASET_ID'

Unique identifier of the default dataset for storing Actor results.

DEFAULT_KEY_VALUE_STORE_ID

DEFAULT_KEY_VALUE_STORE_ID: 'ACTOR_DEFAULT_KEY_VALUE_STORE_ID'

Unique identifier of the default key-value store for Actor data.

DEFAULT_REQUEST_QUEUE_ID

DEFAULT_REQUEST_QUEUE_ID: 'ACTOR_DEFAULT_REQUEST_QUEUE_ID'

Unique identifier of the default request queue for Actor URLs.

EVENTS_WEBSOCKET_URL

EVENTS_WEBSOCKET_URL: 'ACTOR_EVENTS_WEBSOCKET_URL'

WebSocket URL for receiving real-time events from the platform.

FULL_NAME

FULL_NAME: 'ACTOR_FULL_NAME'

Full Actor name in format 'username/actor-name' for identification.

ID

ID: 'ACTOR_ID'

Unique identifier of the Actor definition.

INPUT_KEY

INPUT_KEY: 'ACTOR_INPUT_KEY'

Key in the default key-value store where Actor input is stored (usually 'INPUT').

MAX_PAID_DATASET_ITEMS

MAX_PAID_DATASET_ITEMS: 'ACTOR_MAX_PAID_DATASET_ITEMS'

Maximum number of dataset items that will be charged for pay-per-result Actors.

MAX_TOTAL_CHARGE_USD

MAX_TOTAL_CHARGE_USD: 'ACTOR_MAX_TOTAL_CHARGE_USD'

Maximum total charge limit in USD for pay-per-event Actors.

MEMORY_MBYTES

MEMORY_MBYTES: 'ACTOR_MEMORY_MBYTES'

Amount of memory allocated to the Actor run in megabytes.

PERMISSION_LEVEL

PERMISSION_LEVEL: 'ACTOR_PERMISSION_LEVEL'

Permission level of the Actor.

RUN_ID

RUN_ID: 'ACTOR_RUN_ID'

Unique identifier of this specific Actor run execution.

STANDBY_PORT

STANDBY_PORT: 'ACTOR_STANDBY_PORT'

TCP port number for Actor standby mode HTTP server.

STANDBY_URL

STANDBY_URL: 'ACTOR_STANDBY_URL'

Public URL for accessing the Actor in standby mode.

STARTED_AT

STARTED_AT: 'ACTOR_STARTED_AT'

ISO 8601 timestamp when the Actor run was started (UTC timezone).

TASK_ID

TASK_ID: 'ACTOR_TASK_ID'

Unique identifier of the Actor task (empty if run directly via API).

TIMEOUT_AT

TIMEOUT_AT: 'ACTOR_TIMEOUT_AT'

ISO 8601 timestamp when the Actor run will timeout (UTC timezone).

WEB_SERVER_PORT

WEB_SERVER_PORT: 'ACTOR_WEB_SERVER_PORT'

TCP port number for the Actor's built-in HTTP web server.

WEB_SERVER_URL

WEB_SERVER_URL: 'ACTOR_WEB_SERVER_URL'

Public URL for accessing the Actor's built-in HTTP web server.