Heygen | By Mentor AI

Interact with Heygen API

Overview

This node interacts with the Heygen API to perform various video-related operations. Specifically, the 'Check Video Status' operation allows users to check the processing status of a video by providing its video ID. This is useful in workflows where you need to monitor video generation or processing progress and take subsequent actions based on the video's status.

Use Case Examples

  1. A user generates a video using Heygen and then uses this node to periodically check if the video is ready for download or further processing.
  2. A workflow that triggers notifications or updates a database once a video reaches a certain status, such as 'completed' or 'failed'.

Properties

Name Meaning
Video ID ID of the video to check status for, required to identify which video's status to retrieve.

Output

JSON

  • status - The current status of the video (e.g., processing, completed, failed).
  • video_id - The ID of the video whose status was checked.
  • additionalDetails - Any additional information returned by the Heygen API about the video status.

Dependencies

  • Heygen API key credential required for authentication.

Troubleshooting

  • Common issues include providing an invalid or non-existent video ID, which may result in errors or empty responses from the API.
  • API key authentication failures if the provided API key is invalid or missing.
  • Network or connectivity issues when calling the Heygen API endpoints.

Links

Discussion