Skip to main content

TaskClient

Sub-client for manipulating a single task.

Index

Methods

Methods

call

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

  • Start a task 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/actor-tasks/run-collection/run-task

    Parameters

    • optionalkeyword-onlytask_input: dict | None = None

      Task input dictionary.

    • optionalkeyword-onlybuild: str | None = None

      Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).

    • optionalkeyword-onlymax_items: int | None = None

      Maximum number of results that will be returned by this run. If the Actor is charged per result, you will not be charged for more results than the given limit.

    • optionalkeyword-onlymemory_mbytes: int | None = None

      Memory limit for the run, in megabytes. By default, the run uses a memory limit specified in the task settings.

    • optionalkeyword-onlytimeout_secs: int | None = None

      Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.

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

      Specifies optional webhooks associated with the Actor run, which can be used to receive a notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for the Actor or task, you do not have to add it again here.

    • optionalkeyword-onlywait_secs: int | None = None

      The maximum number of seconds the server waits for the task run to finish. If not provided, waits indefinitely.

    Returns dict | None

delete

  • delete(): None

get

  • get(): dict | None

get_input

  • get_input(): dict | None

last_run

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

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

    Parameters

    • optionalkeyword-onlystatus: ActorJobStatus | None = None

      Consider only runs with this status.

    • optionalkeyword-onlyorigin: MetaOrigin | None = None

      Consider only runs started with this origin.

    Returns RunClient

runs

start

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

  • Start the task and immediately return the Run object.

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

    Parameters

    • optionalkeyword-onlytask_input: dict | None = None

      Task input dictionary.

    • optionalkeyword-onlybuild: str | None = None

      Specifies the Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).

    • optionalkeyword-onlymax_items: int | None = None

      Maximum number of results that will be returned by this run. If the Actor is charged per result, you will not be charged for more results than the given limit.

    • optionalkeyword-onlymemory_mbytes: int | None = None

      Memory limit for the run, in megabytes. By default, the run uses a memory limit specified in the task settings.

    • optionalkeyword-onlytimeout_secs: int | None = None

      Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.

    • optionalkeyword-onlywait_for_finish: int | None = None

      The maximum number of seconds the server waits for the run to finish. By default, it is 0, the maximum value is 60.

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

      Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed. If you already have a webhook set up for the Actor or task, you do not have to add it again here. Each webhook is represented by a dictionary containing these items:

      • event_types: List of `WebhookEventType` values which trigger the webhook.
      • request_url: URL to which to send the webhook HTTP request.
      • payload_template: Optional template for the request payload.

    Returns dict

update

  • update(*, name, task_input, build, max_items, memory_mbytes, timeout_secs, title, 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 task with specified fields.

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

    Parameters

    • optionalkeyword-onlyname: str | None = None

      Name of the task.

    • optionalkeyword-onlytask_input: dict | None = None

      Task input dictionary.

    • optionalkeyword-onlybuild: str | None = None

      Actor build to run. It can be either a build tag or build number. By default, the run uses the build specified in the task settings (typically latest).

    • optionalkeyword-onlymax_items: int | None = None

      Maximum number of results that will be returned by this run. If the Actor is charged per result, you will not be charged for more results than the given limit.

    • optionalkeyword-onlymemory_mbytes: int | None = None

      Memory limit for the run, in megabytes. By default, the run uses a memory limit specified in the task settings.

    • optionalkeyword-onlytimeout_secs: int | None = None

      Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.

    • optionalkeyword-onlytitle: str | None = None

      A human-friendly equivalent of the name.

    • 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_secs: int | 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.

    Returns dict

update_input

  • update_input(*, task_input): dict

webhooks

Page Options