ActorClient

Sub-client for manipulating a single Actor.

Index

Methods

• build
• builds
• call
• delete
• get
• last_run
• runs
• start
• update
• version
• versions
• webhooks

Methods

build

• build(*, version_number, beta_packages, tag, use_cache, wait_for_finish): dict

• Build the Actor.

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

  ---

  Parameters

  • keyword-onlyversion_number: str

  • keyword-onlybeta_packages: bool | None = None

  • keyword-onlytag: str | None = None

  • keyword-onlyuse_cache: bool | None = None

  • keyword-onlywait_for_finish: int | None = None

  Returns dict

builds

• builds(): BuildCollectionClient

• Retrieve a client for the builds of this Actor.

  ---

  Returns BuildCollectionClient

call

• call(*, run_input, content_type, build, max_items, memory_mbytes, timeout_secs, webhooks, wait_secs): dict | None

• Start the Actor and wait for it to finish before returning the Run object.

  It waits indefinitely, unless the wait_secs argument is provided.

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

  ---

  Parameters

  • keyword-onlyrun_input: Any = None

  • keyword-onlycontent_type: str | None = None

  • keyword-onlybuild: str | None = None

  • keyword-onlymax_items: int | None = None

  • keyword-onlymemory_mbytes: int | None = None

  • keyword-onlytimeout_secs: int | None = None

  • keyword-onlywebhooks: list[dict] | None = None

  • keyword-onlywait_secs: int | None = None

  Returns dict | None

delete

• delete(): None

• Delete the Actor.

  https://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor

  ---

  Returns None

get

• get(): dict | None

• Retrieve the Actor.

  https://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor

  ---

  Returns dict | None

last_run

• last_run(*, status, origin): RunClient

• Retrieve the client for the last run of this Actor.

  Last run is retrieved based on the start time of the runs.

  ---

  Parameters

  • keyword-onlystatus: ActorJobStatus | None = None

  • keyword-onlyorigin: MetaOrigin | None = None

  Returns RunClient

runs

• runs(): RunCollectionClient

• Retrieve a client for the runs of this Actor.

  ---

  Returns RunCollectionClient

start

• start(*, run_input, content_type, build, max_items, memory_mbytes, timeout_secs, wait_for_finish, webhooks): dict

• Start the Actor and immediately return the Run object.

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

  ---

  Parameters

  • keyword-onlyrun_input: Any = None

  • keyword-onlycontent_type: str | None = None

  • keyword-onlybuild: str | None = None

  • keyword-onlymax_items: int | None = None

  • keyword-onlymemory_mbytes: int | None = None

  • keyword-onlytimeout_secs: int | None = None

  • keyword-onlywait_for_finish: int | None = None

  • keyword-onlywebhooks: list[dict] | None = None

  Returns dict

update

• update(*, name, title, description, seo_title, seo_description, versions, restart_on_error, is_public, is_deprecated, is_anonymously_runnable, categories, default_run_build, default_run_max_items, default_run_memory_mbytes, default_run_timeout_secs, 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_secs, actor_standby_build, actor_standby_memory_mbytes): dict

• Update the Actor with the specified fields.

  https://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor

  ---

  Parameters

  • keyword-onlyname: str | None = None

  • keyword-onlytitle: str | None = None

  • keyword-onlydescription: str | None = None

  • keyword-onlyseo_title: str | None = None

  • keyword-onlyseo_description: str | None = None

  • keyword-onlyversions: list[dict] | None = None

  • keyword-onlyrestart_on_error: bool | None = None

  • keyword-onlyis_public: bool | None = None

  • keyword-onlyis_deprecated: bool | None = None

  • keyword-onlyis_anonymously_runnable: bool | None = None

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

  • keyword-onlydefault_run_build: str | None = None

  • keyword-onlydefault_run_max_items: int | None = None

  • keyword-onlydefault_run_memory_mbytes: int | None = None

  • keyword-onlydefault_run_timeout_secs: int | None = None

  • keyword-onlyexample_run_input_body: Any = None

  • keyword-onlyexample_run_input_content_type: str | None = None

  • keyword-onlyactor_standby_is_enabled: bool | None = None

  • keyword-onlyactor_standby_desired_requests_per_actor_run: int | None = None

  • keyword-onlyactor_standby_max_requests_per_actor_run: int | None = None

  • keyword-onlyactor_standby_idle_timeout_secs: int | None = None

  • keyword-onlyactor_standby_build: str | None = None

  • keyword-onlyactor_standby_memory_mbytes: int | None = None

  Returns dict

version

• version(version_number): ActorVersionClient

• Retrieve the client for the specified version of this Actor.

  ---

  Parameters

  • version_number: str

  Returns ActorVersionClient

versions

• versions(): ActorVersionCollectionClient

• Retrieve a client for the versions of this Actor.

  ---

  Returns ActorVersionCollectionClient

webhooks

• webhooks(): WebhookCollectionClient

• Retrieve a client for webhooks associated with this Actor.

  ---

  Returns WebhookCollectionClient