Skip to main content
Version: Next

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.

Hierarchy

  • Omit<Schemas[Actor], keyof ActorRePointed>
  • ActorRePointed
  • ActorSpecGaps
    • Actor

Index

Properties

optionalinheritedactorPermissionLevel

actorPermissionLevel?: ACTOR_PERMISSION_LEVEL

optionalinheritedactorStandby

actorStandby?: null | ActorStandby

optionalinheritedcategories

categories?: string[]
[
"DEVELOPER_TOOLS",
"OPEN_SOURCE"
]

A list of categories that best define the Actor. Reflected in Apify Store's search and filtering options.

inheritedcreatedAt

createdAt: Date

Format: date-time

2019-07-08T11:27:57.401Z

The date and time the Actor was created. Follows the ISO 8601 format.

inheriteddefaultRunOptions

defaultRunOptions: ActorDefaultRunOptions

optionalinheriteddeploymentKey

deploymentKey?: string
ssh-rsa AAAA ...

The Actor's public SSH key, used as a deployment key for private Git repositories.

optionalinheriteddescription

description?: null | string
Extract data from hundreds of places fast.

Short description of the Actor, displayed in Apify Store and Console.

optionalinheritedexampleRunInput

exampleRunInput?: null | ActorExampleRunInput

optionalinheritedhasNoDataset

hasNoDataset?: boolean
false

Whether the Actor stores results in a dataset. Set by Apify.

inheritedid

id: string
zdc3Pyhyz3m8vjDeM

The ID of the Actor.

optionalinheritedisAnonymouslyRunnable

isAnonymouslyRunnable?: boolean

Whether the Actor can be run by anonymous users without authentication

optionalinheritedisCritical

isCritical?: boolean
false

Whether the Actor is maintained by Apify.

optionalinheritedisDeprecated

isDeprecated?: null | boolean
false

Whether the Actor is deprecated.

optionalinheritedisGeneric

isGeneric?: boolean
false

Whether the Actor is intended for developers. Set by Apify.

inheritedisPublic

isPublic: boolean
false

Whether the Actor is available to users in Apify Store.

optionalinheritedisSourceCodeHidden

isSourceCodeHidden?: boolean = true
true

Whether the Actor's source files are hidden on its detail page.

inheritedmodifiedAt

modifiedAt: Date

Format: date-time

2019-07-08T14:01:05.546Z

The date and time the Actor was last modified. Follows the ISO 8601 format.

inheritedname

name: string
google-search-extractor

The name of the Actor.

optionalinheritednotice

notice?: null | NONE | RESIDENTIAL_PROXY_REQUIRED | UNDER_MAINTENANCE

optionalinheritedpictureUrl

pictureUrl?: null | string
https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png

URL of the Actor's icon, displayed on the Actor's page in Apify Store and Console.

optionalinheritedpricingInfos

pricingInfos?: ActorRunPricingInfo[]

optionalinheritedreadmeSummary

readmeSummary?: string

An AI-generated Markdown summary of the Actor's README, optimized for search and AI agents. Contains an overview and a list of use cases. Generated only for public Actors.

optionalinheritedrestartOnError

restartOnError?: boolean
false

This API is deprecated and may be removed in a future version.

optionalinheritedseoDescription

seoDescription?: null | string
Crawls websites using Chrome and extracts data from pages using JavaScript.

Description of the Actor to display by search engines such as Google.

optionalinheritedseoTitle

seoTitle?: null | string
Web Scraper

Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Apify Store and Console.

optionalinheritedstandbyUrl

standbyUrl?: null | string
https://jane35--my-actor.apify.actor

URL for sending requests to the Actor in Standby mode. null if the Standby mode isn't enabled.

inheritedstats

stats: ActorStats

optionalinheritedtaggedBuilds

taggedBuilds?: null | ActorTaggedBuilds

optionalinheritedtitle

title?: null | string
Google Search Extractor

Human-readable name of the Actor, displayed in Apify Store and Console.

inheriteduserId

userId: string
wRsJZtadYvn4mBZmm

The ID of the user who owns the Actor.

inheritedusername

username: string
compass

The username of the Actor owner.

inheritedversions

versions: ActorVersion[]