Apify icon

Apify

Apify API

Overview

This node interacts with the Apify API to create a new actor task. It is useful for automating workflows that require running specific tasks on Apify actors, such as web scraping, data processing, or automation scripts. Users can specify the actor ID, task name, options like build version, timeout, and memory allocation, and input parameters for the task. It also supports sending a fully custom request body for advanced use cases.

Use Case Examples

  1. Creating a task to run a web scraper actor with specific input parameters.
  2. Automating data extraction by scheduling tasks on Apify actors with custom options.

Properties

Name Meaning
Act Id The unique identifier of the actor for which the task is created.
Name The name of the task to be created.
Options Optional settings for the task such as build version, timeout in seconds, and memory allocation in megabytes.
Input Input data to be passed to the actor task when it runs.
Use Custom Body Flag to indicate whether to use a custom JSON body for the request instead of the standard parameters.
Custom Body A JSON object representing the full custom request body to send when 'Use Custom Body' is enabled.

Output

JSON

  • id - The unique identifier of the created task.
  • name - The name of the created task.
  • actId - The actor ID associated with the task.
  • options - The options used for the task such as build, timeoutSecs, and memoryMbytes.
  • input - The input data passed to the task.
  • createdAt - Timestamp when the task was created.
  • modifiedAt - Timestamp when the task was last modified.

Dependencies

  • Requires an Apify API key credential for authentication.

Troubleshooting

  • Ensure the Apify API key credential is correctly configured and has the necessary permissions.
  • Verify that the actor ID provided exists and is accessible with the API key used.
  • Check the JSON format of the custom body if 'Use Custom Body' is enabled to avoid syntax errors.
  • Common error messages may include authentication failures, invalid actor ID, or malformed request body. Resolving these involves verifying credentials, actor ID correctness, and JSON syntax respectively.

Links

Discussion