Skip to main content
Version: Next

ActorCollectionClientAsync

Sub-client for the Actor collection.

Provides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate method on the ApifyClientAsync class.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None

  • Initialize the resource client.

    Parameters

    • keyword-onlybase_url: str

      API base URL.

    • keyword-onlypublic_base_url: str

      Public CDN base URL.

    • keyword-onlyhttp_client: HttpClientAsync

      HTTP client for making requests.

    • keyword-onlyresource_path: str

      Resource endpoint path (e.g., 'actors', 'datasets').

    • keyword-onlyclient_registry: ClientRegistryAsync

      Bundle of client classes for dependency injection.

    • optionalkeyword-onlyresource_id: str | None = None

      Optional resource ID for single-resource clients.

    • optionalkeyword-onlyparams: dict | None = None

      Optional default parameters for all requests.

    Returns None

create

  • async create(*, name, title, description, seo_title, seo_description, versions, restart_on_error, is_public, is_deprecated, categories, default_run_build, default_run_max_items, default_run_memory_mbytes, default_run_timeout, example_run_input_body, example_run_input_content_type, actor_standby_is_enabled, actor_standby_desired_requests_per_actor_run, actor_standby_max_requests_per_actor_run, actor_standby_idle_timeout, actor_standby_build, actor_standby_memory_mbytes, timeout): Actor

  • Create a new Actor.

    https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor

    Parameters

    • keyword-onlyname: str

      The name of the Actor.

    • optionalkeyword-onlytitle: str | None = None

      The title of the Actor (human-readable).

    • optionalkeyword-onlydescription: str | None = None

      The description for the Actor.

    • optionalkeyword-onlyseo_title: str | None = None

      The title of the Actor optimized for search engines.

    • optionalkeyword-onlyseo_description: str | None = None

      The description of the Actor optimized for search engines.

    • optionalkeyword-onlyversions: list[dict[str, Any]] | None = None

      The list of Actor versions.

    • optionalkeyword-onlyrestart_on_error: bool | None = None

      If true, the Actor run process will be restarted whenever it exits with a non-zero status code.

    • optionalkeyword-onlyis_public: bool | None = None

      Whether the Actor is public.

    • optionalkeyword-onlyis_deprecated: bool | None = None

      Whether the Actor is deprecated.

    • optionalkeyword-onlycategories: list[str] | None = None

      The categories to which the Actor belongs to.

    • optionalkeyword-onlydefault_run_build: str | None = None

      Tag or number of the build that you want to run by default.

    • optionalkeyword-onlydefault_run_max_items: int | None = None

      Default limit of the number of results that will be returned by runs of this Actor, if the Actor is charged per result.

    • optionalkeyword-onlydefault_run_memory_mbytes: int | None = None

      Default amount of memory allocated for the runs of this Actor, in megabytes.

    • optionalkeyword-onlydefault_run_timeout: timedelta | None = None

      Default timeout for the runs of this Actor.

    • optionalkeyword-onlyexample_run_input_body: Any = None

      Input to be prefilled as default input to new users of this Actor.

    • optionalkeyword-onlyexample_run_input_content_type: str | None = None

      The content type of the example run input.

    • optionalkeyword-onlyactor_standby_is_enabled: bool | None = None

      Whether the Actor Standby is enabled.

    • optionalkeyword-onlyactor_standby_desired_requests_per_actor_run: int | None = None

      The desired number of concurrent HTTP requests for a single Actor Standby run.

    • optionalkeyword-onlyactor_standby_max_requests_per_actor_run: int | None = None

      The maximum number of concurrent HTTP requests for a single Actor Standby run.

    • optionalkeyword-onlyactor_standby_idle_timeout: timedelta | None = None

      If the Actor run does not receive any requests for this time, it will be shut down.

    • optionalkeyword-onlyactor_standby_build: str | None = None

      The build tag or number to run when the Actor is in Standby mode.

    • optionalkeyword-onlyactor_standby_memory_mbytes: int | None = None

      The memory in megabytes to use when the Actor is in Standby mode.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns Actor

    The created Actor.

iterate

  • iterate(*, my, limit, offset, desc, sort_by, timeout): AsyncIterator[ActorShort]

  • Iterate over the Actors the user has created or used.

    Simple list does only one API call, possibly not listing all items matching the criteria. This method returns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.

    https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors

    Parameters

    • optionalkeyword-onlymy: bool | None = None

      If True, will return only Actors which the user has created themselves.

    • optionalkeyword-onlylimit: int | None = None

      How many Actors to list.

    • optionalkeyword-onlyoffset: int | None = None

      What Actor to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

      Whether to sort the Actors in descending order based on their creation date.

    • optionalkeyword-onlysort_by: Literal[createdAt, stats.lastRunStartedAt] | None = 'createdAt'

      Field to sort the results by.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns AsyncIterator[ActorShort]

list

  • async list(*, my, limit, offset, desc, sort_by, timeout): ListOfActors

  • List the Actors the user has created or used.

    https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors

    Parameters

    • optionalkeyword-onlymy: bool | None = None

      If True, will return only Actors which the user has created themselves.

    • optionalkeyword-onlylimit: int | None = None

      How many Actors to list.

    • optionalkeyword-onlyoffset: int | None = None

      What Actor to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

      Whether to sort the Actors in descending order based on their creation date.

    • optionalkeyword-onlysort_by: Literal[createdAt, stats.lastRunStartedAt] | None = 'createdAt'

      Field to sort the results by.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns ListOfActors

    The list of available Actors matching the specified filters.

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options