UseAPI icon

UseAPI

Interact with RunwayML through UseAPI
Join our community

Actions22

Overview

This node integrates with the RunwayML service via the UseAPI platform, specifically supporting the "Get Tasks List" operation under the "Runway" resource. It retrieves a paginated list of tasks from RunwayML, optionally filtered by task statuses and email.

Common scenarios where this node is beneficial include:

  • Monitoring and managing asynchronous or batch processing tasks in RunwayML.
  • Fetching task status updates to trigger subsequent workflow steps based on task completion or failure.
  • Filtering tasks by their current state (e.g., pending, running, succeeded) to analyze workload or debug issues.

Practical example:

  • A user wants to retrieve the first 50 tasks starting from offset 0, filtering only those tasks that are currently "RUNNING" or "PENDING" to monitor active jobs.

Properties

Name Meaning
Offset Starting position for pagination; an integer between 0 and 1000 indicating where to start fetching tasks.
Limit Maximum number of task results to return; minimum value is 1.
Additional Fields Optional extra filters:
  Statuses Comma-separated list of task statuses to filter by. Possible values: PENDING, RUNNING, THROTTLED, SUCCEEDED, FAILED.

Output

The node outputs a JSON array where each item corresponds to a task retrieved from RunwayML. The structure of each task object reflects the API response from the /runwayml/tasks/ endpoint and typically includes fields such as task ID, status, timestamps, and other metadata related to the task.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for UseAPI with access to RunwayML endpoints.
  • The node makes HTTP GET requests to the UseAPI RunwayML tasks endpoint (https://api.useapi.net/v1/runwayml/tasks/).
  • Proper configuration of the API key credential in n8n is necessary for authentication.

Troubleshooting

  • Missing or invalid API key: The node will fail if the API key credential is not set or invalid. Ensure the API key is correctly configured.
  • Invalid offset or limit values: Providing offset outside 0-1000 or limit less than 1 may cause errors or unexpected results.
  • Incorrect statuses filter format: The statuses field must be a comma-separated string of valid statuses. Invalid values may result in no tasks returned or API errors.
  • Network or API errors: If the UseAPI service is unreachable or returns errors, the node will throw exceptions. Check network connectivity and API service status.
  • Handling errors gracefully: The node supports continuing on failure, allowing workflows to handle errors without stopping execution.

Links and References

Discussion