ActorCollectionClientAsync
apify_client.clients.ActorCollectionClientAsync
Index
Methods
create
Create a new actor.
https://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor
Parameters
name: strkeyword-only
The name of the actor
title: str | None = Nonekeyword-only
The title of the actor (human-readable)
description: str | None = Nonekeyword-only
The description for the actor
seo_title: str | None = Nonekeyword-only
The title of the actor optimized for search engines
seo_description: str | None = Nonekeyword-only
The description of the actor optimized for search engines
versions: list[dict] | None = Nonekeyword-only
The list of actor versions
restart_on_error: bool | None = Nonekeyword-only
If true, the main actor run process will be restarted whenever it exits with a non-zero status code.
is_public: bool | None = Nonekeyword-only
Whether the actor is public.
is_deprecated: bool | None = Nonekeyword-only
Whether the actor is deprecated.
is_anonymously_runnable: bool | None = Nonekeyword-only
Whether the actor is anonymously runnable.
categories: list[str] | None = Nonekeyword-only
The categories to which the actor belongs to.
default_run_build: str | None = Nonekeyword-only
Tag or number of the build that you want to run by default.
default_run_max_items: int | None = Nonekeyword-only
Default limit of the number of results that will be returned by runs of this Actor, if the Actor is charged per result.
default_run_memory_mbytes: int | None = Nonekeyword-only
Default amount of memory allocated for the runs of this actor, in megabytes.
default_run_timeout_secs: int | None = Nonekeyword-only
Default timeout for the runs of this actor in seconds.
example_run_input_body: Any = Nonekeyword-only
Input to be prefilled as default input to new users of this actor.
example_run_input_content_type: str | None = Nonekeyword-only
The content type of the example run input.
Returns dict
The created actor.
list
List the actors the user has created or used.
https://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors
Parameters
my: bool | None = Nonekeyword-only
If True, will return only actors which the user has created themselves.
limit: int | None = Nonekeyword-only
How many actors to list
offset: int | None = Nonekeyword-only
What actor to include as first when retrieving the list
desc: bool | None = Nonekeyword-only
Whether to sort the actors in descending order based on their creation date
Returns ListPage[dict]
The list of available actors matching the specified filters.
Async sub-client for manipulating actors.