Actor

Index

Properties

• actor_permission_level
• actor_standby
• categories
• created_at
• default_run_options
• deployment_key
• description
• example_run_input
• has_no_dataset
• id
• is_critical
• is_deprecated
• is_generic
• is_public
• is_source_code_hidden
• model_config
• modified_at
• name
• notice
• picture_url
• pricing_infos
• readme_summary
• restart_on_error
• seo_description
• seo_title
• standby_url
• stats
• tagged_builds
• title
• user_id
• username
• versions

Properties

actor_permission_level

actor_permission_level: ActorPermissionLevel | None

actor_standby

actor_standby: ActorStandby | None

categories

categories: list[str] | None

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

created_at

created_at: AwareDatetime

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

default_run_options

default_run_options: DefaultRunOptions

deployment_key

deployment_key: str | None

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

description

description: str | None

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

example_run_input

example_run_input: ExampleRunInput | None

has_no_dataset

has_no_dataset: bool | None

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

id

id: str

The ID of the Actor.

is_critical

is_critical: bool | None

Whether the Actor is maintained by Apify.

is_deprecated

is_deprecated: bool | None

Whether the Actor is deprecated.

is_generic

is_generic: bool | None

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

is_public

is_public: bool

Whether the Actor is available to users in Apify Store.

is_source_code_hidden

is_source_code_hidden: bool | None

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

model_config

model_config: Undefined

modified_at

modified_at: AwareDatetime

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

name

name: str

The name of the Actor.

notice

notice: ActorNotice | None

picture_url

picture_url: str | None

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

pricing_infos

pricing_infos: list[((PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo) | FlatPricePerMonthActorPricingInfo) | FreeActorPricingInfo] | None

readme_summary

readme_summary: str | None

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.

restart_on_error

restart_on_error: bool | None

seo_description

seo_description: str | None

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

seo_title

seo_title: str | None

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.

standby_url

standby_url: str | None

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

stats

stats: ActorStats

tagged_builds

tagged_builds: dict[str, TaggedBuildInfo | None] | None

title

title: str | None

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

user_id

user_id: str

The ID of the user who owns the Actor.

username

username: str

The username of the Actor owner.

versions

versions: list[Version]

An array of Version objects. Each object represents a specific version of the Actor's source code: its location, builds, and environment configuration.