Start task - Automate.ax

apify.startTask starts a saved Apify task and returns its initial run state.

Example

automations/apify-start-task.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { apify } from "automate.ax/apify"

export default automation("Start task", () => {
  onHttpRequest({ scope: "automation" })

  apify.startTask({
    taskId: "username/task-name",
    input: { maxRequestsPerCrawl: 100 },
  })
})

Inputs

Field	Type	Required	Description
`taskId`	`string`	Yes	Task ID or `username/name` reference.
`input`	`Record<string, JSON>`	No	Properties that override the task’s saved input.
`build`	`string`	No	Build tag or number.
`maxItems`	`number`	No	Maximum paid dataset items.
`maxTotalChargeUsd`	`number`	No	Maximum total charge in US dollars.
`memoryMbytes`	`number`	No	Power-of-two memory from 128 to 32768 MB.
`restartOnError`	`boolean`	No	Restart after a container error.
`timeoutSecs`	`number`	No	Maximum run time; `0` disables the timeout.

Output

Returns the created Actor run with status, storage IDs, timestamps, options, and usage. The action does not wait for completion. Input properties override, rather than replace, the task’s saved input. Starting the task again creates another run.