HeyGen icon

HeyGen

Consume HeyGen API

Overview

The "Get Video Status" operation of the HeyGen node allows users to retrieve the current status and details of a previously created video by providing its unique video ID. This is useful for workflows where videos are generated asynchronously, and you need to check if the video processing is complete, still in progress, or if any errors occurred.

Typical use cases include:

  • Monitoring video generation jobs to trigger subsequent actions once the video is ready.
  • Fetching metadata or status updates about a video for reporting or logging purposes.
  • Integrating with other systems that require confirmation of video availability before proceeding.

For example, after initiating a video creation, you can periodically call this operation with the video ID to check if the video is finished and then download or share it.

Properties

Name Meaning
Video ID The unique identifier of the video whose status you want to check. This property is required.

Output

The output JSON contains the response from the HeyGen API endpoint that provides the status and details of the specified video. While the exact structure depends on the API response, it typically includes fields such as:

  • Video status (e.g., processing, completed, failed)
  • Video metadata (e.g., creation time, duration, resolution)
  • URLs or references to the generated video file(s)
  • Any error messages or codes if the video failed to process

This output enables downstream nodes or processes to make decisions based on the video's readiness or details.

The node does not output binary data for this operation; it only returns JSON metadata about the video status.

Dependencies

  • Requires an active connection to the HeyGen API service.
  • Needs a valid API authentication token configured in the node credentials to authorize requests.
  • The node uses the HeyGen API version 1 endpoint /video_status.get to fetch video status.

Troubleshooting

  • Missing or invalid Video ID: If the provided Video ID is empty or incorrect, the API will likely return an error indicating the video was not found. Ensure the Video ID is correct and corresponds to a video previously created.
  • API authentication errors: If the API key or token is missing or invalid, the request will fail with an authentication error. Verify that the API credentials are properly set up in n8n.
  • Network or connectivity issues: Failures to reach the HeyGen API endpoint may occur due to network problems. Check your internet connection and firewall settings.
  • Unexpected API responses: If the API changes or returns unexpected data, the node might throw errors or produce incomplete output. In such cases, consult HeyGen API documentation or support.

Links and References


If you need further details on other operations or resources, feel free to ask!

Discussion