Vidopi Task Status
AI-generatedOverview
This node checks the status of an asynchronous processing task in Vidopi by querying the Vidopi API with a given Task ID. It is useful for workflows that need to monitor the progress or completion of video processing tasks started earlier. The node can either return the current status immediately or poll the API repeatedly until the task completes or fails, with configurable polling intervals and maximum wait times.
Use Case Examples
- A user starts a video processing task in Vidopi and wants to wait until the task finishes before proceeding with further workflow steps.
- A workflow periodically checks the status of a Vidopi task without waiting, to update a dashboard or trigger notifications based on task progress.
Properties
| Name | Meaning |
|---|---|
| Task ID | Identifier returned when you start an asynchronous Vidopi task, used to query the task status. |
| Wait For Completion | Whether to poll the Vidopi API repeatedly until the task completes or fails, or to return the current status immediately. |
| Poll Interval (seconds) | Seconds to wait between status checks when polling for task completion. |
| Max Wait Time (seconds) | Maximum amount of time to wait for task completion before timing out when polling. |
Output
JSON
task_id- The Task ID queried.status- Current status of the Vidopi task (e.g., SUCCESS, FAILED, or other states).- ``
*
* `` - Additional details returned by the Vidopi API about the task status and result.
Dependencies
- Vidopi API accessed via HTTP GET requests to https://api.vidopi.com/task-status/{taskId}
- Requires an API key credential for authentication in the request header 'X-API-Key'.
Troubleshooting
- If the task does not complete within the specified max wait time, the node throws a timeout error indicating the last known status.
- If no response is received from the Vidopi API, an error is thrown indicating no response.
- Common errors include invalid Task ID or expired API key, which will result in API request failures.
- Ensure the Poll Interval and Max Wait Time are set to reasonable values to avoid excessive waiting or premature timeouts.
Links
- Vidopi API Documentation - Official API documentation for Vidopi, including task status endpoints and authentication details.