TaskClient

Client for managing a specific Actor task.

Tasks are pre-configured Actor runs with saved input and options. This client provides methods to start, call, update, and delete tasks, as well as manage their runs and webhooks.

Hierarchy

• ResourceClient
  • TaskClient

const client = new ApifyClient({ token: 'my-token' });
const taskClient = client.task('my-task-id');

// Start a task
const run = await taskClient.start();

// Call a task and wait for it to finish
const finishedRun = await taskClient.call();

See more at https://docs.apify.com/platform/actors/running/tasks

Index

Properties

• apifyClient
• baseUrl
• httpClient
• id
• params
• publicBaseUrl
• resourcePath
• safeId
• url

Methods

• call
• delete
• get
• getInput
• lastRun
• publish
• runs
• start
• unpublish
• update
• updateInput
• webhooks

Properties

inheritedapifyClient

apifyClient: ApifyClient

Inherited from ResourceClient.apifyClient

inheritedbaseUrl

baseUrl: string

Inherited from ResourceClient.baseUrl

inheritedhttpClient

httpClient: HttpClient

Inherited from ResourceClient.httpClient

optionalinheritedid

id?: string

Inherited from ResourceClient.id

optionalinheritedparams

params?: Record<string, unknown>

Inherited from ResourceClient.params

inheritedpublicBaseUrl

publicBaseUrl: string

Inherited from ResourceClient.publicBaseUrl

inheritedresourcePath

resourcePath: string

Inherited from ResourceClient.resourcePath

optionalinheritedsafeId

safeId?: string

Inherited from ResourceClient.safeId

inheritedurl

url: string

Inherited from ResourceClient.url

Methods

call

• call(input, options): Promise<ActorRun>

• Starts a task and waits for it to finish before returning the Run object. It waits indefinitely, unless the waitSecs option is provided.

  ---

  Parameters

  • optionalinput: Dictionary

    Input overrides for the task. If not provided, the task's saved input is used.

  • options: TaskCallOptions = {}

    Run and wait options.

  Returns Promise<ActorRun>

  The Actor run object.

  See more at https://docs.apify.com/api/v2/actor-task-runs-post

delete

• delete(): Promise<void>

• Deletes the Task.

  ---

  Returns Promise<void>

  See more at https://docs.apify.com/api/v2/actor-task-delete

get

• get(): Promise<undefined | Task>

• Retrieves the Actor task.

  ---

  Returns Promise<undefined | Task>

  The task object, or undefined if it does not exist.

  See more at https://docs.apify.com/api/v2/actor-task-get

getInput

• getInput(): Promise<undefined | Dictionary | Dictionary[]>

• Retrieves the Actor task's input object.

  ---

  Returns Promise<undefined | Dictionary | Dictionary[]>

  The Task's input, or undefined if it does not exist.

  See more at https://docs.apify.com/api/v2/actor-task-input-get

lastRun

• lastRun(options): RunClient

• Returns a client for the last run of this task.

  ---

  Parameters

  • options: TaskLastRunOptions = {}

    Filter options for the last run.

  Returns RunClient

  A client for the last run.

  See more at https://docs.apify.com/api/v2/actor-task-runs-last-get

publish

• publish(): Promise<Task>

• Publishes the task on its public landing page, by setting isPublic through TaskClient.update.

  The task's Actor must be public and the task must have its public display configuration (publicConfig) set up first. Requires write permission to both the task and its Actor. Publishing an already published task does nothing.

  ---

  Returns Promise<Task>

  The task object.

  See more at https://docs.apify.com/api/v2/actor-task-put

runs

• runs(): RunCollectionClient

• Returns a client for the Runs of this Task.

  ---

  Returns RunCollectionClient

  A client for the task's runs.

  See more at https://docs.apify.com/api/v2/actor-task-runs-get

start

• start(input, options): Promise<ActorRun>

• Starts an Actor task and immediately returns the Run object.

  ---

  Parameters

  • optionalinput: Dictionary

    Input overrides for the task. If not provided, the task's saved input is used.

  • options: TaskStartOptions = {}

    Run options.

  Returns Promise<ActorRun>

  The Actor Run object.

  See more at https://docs.apify.com/api/v2/actor-task-runs-post

unpublish

• unpublish(): Promise<Task>

• Unpublishes the task from its public landing page, by setting isPublic through TaskClient.update.

  The public display configuration (publicConfig) is preserved, so the task can be published again without re-entering it. Requires write permission to both the task and its Actor. Unpublishing a task that is not published does nothing.

  ---

  Returns Promise<Task>

  The task object.

  See more at https://docs.apify.com/api/v2/actor-task-put

update

• update(newFields): Promise<Task>

• Updates the task with the specified fields.

  ---

  Parameters

  • newFields: TaskUpdateData

    Fields to update.

  Returns Promise<Task>

  The updated task object.

  See more at https://docs.apify.com/api/v2/actor-task-put

updateInput

• updateInput(newFields): Promise<Dictionary | Dictionary[]>

• Updates the Actor task's input object.

  ---

  Parameters

  • newFields: Dictionary | Dictionary[]

    New input data for the task.

  Returns Promise<Dictionary | Dictionary[]>

  The updated task input.

  See more at https://docs.apify.com/api/v2/actor-task-input-put

webhooks

• webhooks(): WebhookCollectionClient

• Returns a client for the Webhooks of this Task.

  ---

  Returns WebhookCollectionClient

  A client for the task's webhooks.

  See more at https://docs.apify.com/api/v2/actor-task-webhooks-get