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.

@example

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

https://docs.apify.com/platform/actors/running/tasks

Hierarchy

• ResourceClient
  • TaskClient

Index

Properties

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

Methods

• call
• delete
• get
• getInput
• lastRun
• runs
• start
• 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.

  @see

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

  ---

  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.

delete

• delete(): Promise<void>

• Deletes the Task.

  @see

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

  ---

  Returns Promise<void>

get

• get(): Promise<undefined | Task>

• Retrieves the Actor task.

  @see

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

  ---

  Returns Promise<undefined | Task>

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

getInput

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

• Retrieves the Actor task's input object.

  @see

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

  ---

  Returns Promise<undefined | Dictionary | Dictionary[]>

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

lastRun

• lastRun(options): RunClient

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

  @see

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

  ---

  Parameters

  • options: TaskLastRunOptions = {}

    Filter options for the last run.

  Returns RunClient

  A client for the last run.

runs

• runs(): RunCollectionClient

• Returns a client for the Runs of this Task.

  @see

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

  ---

  Returns RunCollectionClient

  A client for the task's runs.

start

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

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

  @see

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

  ---

  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.

update

• update(newFields): Promise<Task>

• Updates the task with the specified fields.

  @see

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

  ---

  Parameters

  • newFields: Partial<Pick<Task, name | description | title | actorStandby | input | options>>

    Fields to update.

  Returns Promise<Task>

  The updated task object.

updateInput

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

• Updates the Actor task's input object.

  @see

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

  ---

  Parameters

  • newFields: Dictionary | Dictionary[]

    New input data for the task.

  Returns Promise<Dictionary | Dictionary[]>

  The updated task input.

webhooks

• webhooks(): WebhookCollectionClient

• Returns a client for the Webhooks of this Task.

  @see

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

  ---

  Returns WebhookCollectionClient

  A client for the task's webhooks.