Skip to main content
Version: Next

ActorDefinition

Actor definition from the .actor/actor.json file.

Contains the Actor's configuration, input schema, and other metadata.

Hierarchy

  • GeneratedActorDefinition
    • ActorDefinition

See more at https://docs.apify.com/platform/actors/development/actor-definition/actor-json

Added in 2.11.0

Index

Properties

Properties

optionalinheritedactorSpecification

actorSpecification?: 1

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

optionalinheritedbuildTag

buildTag?: string

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

optionalinheritedchangelog

changelog?: null | string

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

optionalinheriteddefaultMemoryMbytes

defaultMemoryMbytes?: string | number

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.

optionalinheriteddescription

description?: string

The description of the Actor.

optionalinheriteddockerContextDir

dockerContextDir?: string

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

optionalinheriteddockerfile

dockerfile?: string

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

optionalinheritedenvironmentVariables

environmentVariables?: {}

Type declaration

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

    optionalinheritedinput

    input?: null | Record<string, unknown>

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

    optionalinheritedmaxMemoryMbytes

    maxMemoryMbytes?: number

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

    optionalinheritedmeta

    meta?: { generatedBy?: string; templateId?: string }

    Type declaration

    • optionalgeneratedBy?: string

      The tool or model that generated the Actor.

    • optionaltemplateId?: string

      The ID of the template from which the Actor was created.

    optionalinheritedminMemoryMbytes

    minMemoryMbytes?: number

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

    optionalinheritedname

    name?: string

    The name of the Actor.

    optionalinheritedoutput

    output?: null | Record<string, unknown>

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

    optionalinheritedreadme

    readme?: null | string

    The path to the README file for the Actor.

    optionalinheritedstorages

    storages?: { dataset?: Record<string, unknown>; datasets?: {}; keyValueStore?: Record<string, unknown> }

    Type declaration

    • optionaldataset?: Record<string, unknown>

      Defines the schema of items in your dataset, the full specification can be found in Apify docs

    • optionaldatasets?: {}

      Maps dataset aliases to the schemas of the Actor's datasets, the full specification can be found in Apify docs

      • optionalkeyValueStore?: Record<string, unknown>

        Defines the schema of the Actor's default key-value store, the full specification can be found in Apify docs

      optionalinheritedtitle

      title?: string

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

      optionalinheritedusesStandbyMode

      usesStandbyMode?: boolean

      Specifies whether Standby mode is enabled for the Actor.

      optionalinheritedversion

      version?: string

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

      optionalinheritedwebServerMcpPath

      webServerMcpPath?: string

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

      optionalinheritedwebServerSchema

      webServerSchema?: Record<string, unknown>

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

      Page Options