Apify icon

Apify

Apify API

Overview

This node interacts with the Apify API to retrieve details about a specific run of an Actor. It is useful for monitoring and managing Actor executions by fetching run status and metadata. For example, users can get the status of a web scraping job or automation task run by specifying the Actor ID and Run ID.

Use Case Examples

  1. Retrieve the status and details of a specific Actor run by providing the Actor ID and Run ID.
  2. Wait for an Actor run to finish and get the final status by setting the 'Wait For Finish' parameter.

Properties

Name Meaning
Actor ID The unique identifier or username/name combination of the Actor whose run details are to be fetched. It supports selection from a list, URL input, or direct ID input.
Run ID The unique identifier of the specific run of the Actor to retrieve. It supports selection from a list, URL input, or direct ID input.
Wait For Finish Maximum number of seconds to wait for the run to finish before returning. Default is 60 seconds, with a maximum of 60 seconds. If the run finishes within this time, the returned run object will have a terminal status; otherwise, it will have a transitional status.
Use Custom Body Boolean flag to indicate whether to use a custom request body for the API call.

Output

JSON

  • run
    • id - The unique identifier of the Actor run.
    • status - The current status of the run (e.g., RUNNING, SUCCEEDED).
    • startedAt - Timestamp when the run started.
    • finishedAt - Timestamp when the run finished, if applicable.
    • metadata - Additional metadata related to the run.

Dependencies

  • Requires Apify API key credential for authentication.

Troubleshooting

  • Ensure the Actor ID and Run ID are valid and correctly formatted; invalid IDs will cause errors.
  • If the 'Wait For Finish' time is too short, the run may still be in a transitional state when returned.
  • Network or authentication errors may occur if the Apify API key is missing or invalid.

Links

Discussion