Overview

This node operation retrieves the status and details of a specific video using the HeyGen API. It is useful for monitoring the progress or completion of video generation tasks initiated through the HeyGen platform. For example, after requesting a video creation, you can use this operation to check if the video is ready, still processing, or if there were any errors.

Use Case Examples

1. Check the status of a video by providing its unique Video ID to see if the video generation is complete.
2. Monitor multiple video generation jobs by periodically querying their statuses using their Video IDs.

Properties

Output

JSON

• video_id - The unique identifier of the video.
• status - Current status of the video (e.g., processing, completed, failed).
• progress - Progress percentage of the video generation.
• created_at - Timestamp when the video was created.
• updated_at - Timestamp of the last update to the video status.
• details - Additional details or metadata about the video status.

Dependencies

• HeyGen API key credential required for authentication.

Troubleshooting

• Ensure the Video ID provided is correct and corresponds to an existing video in the HeyGen system.
• Check that the HeyGen API credentials are correctly configured and have the necessary permissions.
• If the API returns an error, verify network connectivity and API endpoint availability.
• Handle cases where the video status might be delayed or not updated immediately after creation.

Links

• HeyGen API Video Status Documentation - Official documentation for the HeyGen API endpoint to get video status and details.