Skip to main content
Version: 3.0

CreateActorRequest

Index

Properties

actor_standby

actor_standby: ActorStandby | None

The configuration of the Actor's standby mode. For details, see Standby mode.

categories

categories: list[str] | None

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

default_run_options

default_run_options: DefaultRunOptions | None

description

description: str | None

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

example_run_input

example_run_input: ExampleRunInput | None

Sample input payload that demonstrates what a typical run input for an Actor looks like. Used when no explicit input for a run is provided.

is_deprecated

is_deprecated: bool | None

Whether the Actor is deprecated.

is_public

is_public: bool | None

Whether the Actor is available to users in Apify Store. If false, the Actor is private and only visible to you.

model_config

model_config: Undefined

name

name: str | None

The identifier of the Actor. Use lowercase letters, numbers, and hyphens. Spaces or special characters aren't allowed. Must be unique across your account.

pricing_infos

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. Recommended length is 140-156 characters.

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. Recommended length is 40-50 characters.

title

title: str | None

Human-readable name of the Actor, displayed in Apify Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.

versions

versions: list[Version] | None

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