Actor

Represents an Actor in the Apify platform.

Actors are serverless computing units that can perform arbitrary tasks such as web scraping, data processing, automation, and more. Each Actor has versions, builds, and can be executed with different configurations.

Index

Properties

• actorStandby
• categories
• createdAt
• defaultRunOptions
• deploymentKey
• description
• exampleRunInput
• id
• isAnonymouslyRunnable
• isDeprecated
• isPublic
• modifiedAt
• name
• pricingInfos
• restartOnError
• seoDescription
• seoTitle
• stats
• taggedBuilds
• title
• userId
• username
• versions

Properties

optionalactorStandby

actorStandby?: ActorStandby & { isEnabled: boolean }

Standby mode configuration for keeping Actor warm and responsive

optionalcategories

categories?: string[]

Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING')

createdAt

createdAt: Date

Timestamp when the Actor was created

defaultRunOptions

defaultRunOptions: ActorDefaultRunOptions

Default configuration options for Actor runs

deploymentKey

deploymentKey: string

Deployment key used for automated deployments

optionaldescription

description?: string

Detailed description of what the Actor does

optionalexampleRunInput

exampleRunInput?: ActorExampleRunInput

Example input to help users understand how to use the Actor

id

id: string

Unique Actor ID

optionalisAnonymouslyRunnable

isAnonymouslyRunnable?: boolean

Whether the Actor can be run by anonymous users without authentication

optionalisDeprecated

isDeprecated?: boolean

Whether the Actor is deprecated and should not be used

isPublic

isPublic: boolean

Whether the Actor is publicly available in Apify Store

modifiedAt

modifiedAt: Date

Timestamp when the Actor was last modified

name

name: string

Unique name of the Actor (used in API paths, e.g., 'my-actor')

optionalpricingInfos

pricingInfos?: ActorRunPricingInfo[]

Pricing information for pay-per-result or pay-per-event Actors

optionalrestartOnError

restartOnError?: boolean

@deprecated

Use defaultRunOptions.restartOnError instead

optionalseoDescription

seoDescription?: string

SEO-optimized description for the Actor's public page

optionalseoTitle

seoTitle?: string

SEO-optimized title for the Actor's public page

stats

stats: ActorStats

Usage and run statistics for the Actor

optionaltaggedBuilds

taggedBuilds?: ActorTaggedBuilds

Mapping of tags to specific builds (e.g., 'latest', 'beta')

optionaltitle

title?: string

Human-readable title of the Actor (displayed in UI)

userId

userId: string

ID of the user who owns the Actor

username

username: string

Username of the Actor's owner

versions

versions: ActorVersion[]

All versions of this Actor