ActorDefinition

The definition of the Actor, the full specification of this field can be found in Apify docs.

Index

Properties

• actor_specification
• build_tag
• changelog
• default_memory_mbytes
• description
• docker_context_dir
• dockerfile
• environment_variables
• input
• max_memory_mbytes
• meta
• min_memory_mbytes
• model_config
• name
• output
• readme
• storages
• title
• uses_standby_mode
• version
• web_server_mcp_path
• web_server_schema

Properties

actor_specification

actor_specification: Literal[1] | None

The Actor specification version that this Actor follows. This property must be set to 1.

build_tag

build_tag: str | None

The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified.

changelog

changelog: str | None

The path to the CHANGELOG file displayed in the Actor's information tab.

default_memory_mbytes

default_memory_mbytes: (str | int) | None

Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a dynamic memory expression.

description

description: str | None

The description of the Actor.

docker_context_dir

docker_context_dir: str | None

The path to the directory used as the Docker context when building the Actor.

dockerfile

dockerfile: str | None

The path to the Dockerfile used for building the Actor on the platform.

environment_variables

environment_variables: dict[str, str] | None

A map of environment variables to be used during local development and deployment.

input

input: dict[str, Any] | None

The input schema object, the full specification can be found in Apify docs

max_memory_mbytes

max_memory_mbytes: int | None

Specifies the maximum amount of memory in megabytes required by the Actor.

meta

meta: ActorDefinitionMeta | None

min_memory_mbytes

min_memory_mbytes: int | None

Specifies the minimum amount of memory in megabytes required by the Actor.

model_config

model_config: Undefined

name

name: str | None

The name of the Actor.

output

output: dict[str, Any] | None

The output schema object, the full specification can be found in Apify docs

readme

readme: str | None

The path to the README file for the Actor.

storages

storages: Storages | None

title

title: str | None

The human-readable display title of the Actor, shown in Apify Console and Apify Store.

uses_standby_mode

uses_standby_mode: bool | None

Specifies whether Standby mode is enabled for the Actor.

version

version: str | None

The version of the Actor, typically a dot-separated sequence of numbers (e.g., 0.1, 1.0, or 0.0.1).

web_server_mcp_path

web_server_mcp_path: str | None

The HTTP path where the Actor's web server exposes its MCP (Model Context Protocol) server, for example /mcp.

web_server_schema

web_server_schema: dict[str, Any] | None

The OpenAPI v3 specification of the web server running in the Actor, the full specification can be found in Apify docs