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
  • ActorDefinitionSpecGaps
    • 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.

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.

    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 | object

    Output schema for the Actor.

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

    optionalinheritedreadme

    readme?: null | string

    The path to the README file for the Actor.

    optionalinheritedstorages

    storages?: { dataset?: 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

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

    Page Options