Skip to main content

TaskCollectionClient

apify_client.clients.TaskCollectionClient

Sub-client for manipulating tasks.

Index

Methods

Methods

create

  • create(*, actor_id, name, build, timeout_secs, memory_mbytes, max_items, task_input, title): Dict

  • Create a new task.

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

    Parameters

    • actor_id: strkeyword-only

      Id of the actor that should be run

    • name: strkeyword-only

      Name of the task

    • build: Optional[str] = Noneoptionalkeyword-only

      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).

    • timeout_secs: Optional[int] = Noneoptionalkeyword-only

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

    • memory_mbytes: Optional[int] = Noneoptionalkeyword-only

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

    • max_items: Optional[int] = Noneoptionalkeyword-only

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

    • task_input: Optional[Dict] = Noneoptionalkeyword-only

      Task input object.

    • title: Optional[str] = Noneoptionalkeyword-only

      A human-friendly equivalent of the name

    Returns Dict

    The created task.

list

  • list(*, limit, offset, desc): ListPage[Dict]

  • List the available tasks.

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

    Parameters

    • limit: Optional[int] = Noneoptionalkeyword-only

      How many tasks to list

    • offset: Optional[int] = Noneoptionalkeyword-only

      What task to include as first when retrieving the list

    • desc: Optional[bool] = Noneoptionalkeyword-only

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

    Returns ListPage[Dict]

    The list of available tasks matching the specified filters.