Actions15
Overview
This node interacts with the HeyGen API to manage and generate photo avatars. Specifically, the Check Generation Status operation allows users to query the status of a previously requested avatar photo generation job by providing its unique generation ID. This is useful in workflows where avatar generation is asynchronous, and you need to poll or verify when the generation process has completed or check its current state.
Common scenarios include:
- Monitoring the progress of an avatar photo generation request.
- Triggering subsequent workflow steps only after the avatar photo is ready.
- Handling errors or retries based on the generation status.
Example: After initiating a photo avatar generation, use this operation to periodically check if the avatar is ready for download or further processing.
Properties
| Name | Meaning |
|---|---|
| Generation ID | The unique identifier of the avatar photo generation job whose status you want to check. This is required to query the status. |
Output
The output JSON contains the response from the HeyGen API endpoint that provides the status of the photo avatar generation job. It typically includes fields such as:
- Current status of the generation (e.g., pending, processing, completed, failed).
- Any relevant metadata about the generation job.
- Possibly URLs or IDs for the generated avatar once complete.
The exact structure depends on the HeyGen API response but generally informs whether the avatar generation is done and any related details.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the HeyGen API via an API key credential configured in n8n.
- Network access to HeyGen's endpoints.
- Proper configuration of the HeyGen API credentials in n8n settings.
Troubleshooting
- Invalid or missing Generation ID: Ensure the "Generation ID" property is correctly set and corresponds to a valid generation job.
- API authentication errors: Verify that the HeyGen API key credential is correctly configured and has necessary permissions.
- Network issues: Check connectivity to the HeyGen API service.
- Unexpected API responses: If the API returns errors or unexpected data, confirm the generation ID is correct and the job exists.
- Rate limiting: Avoid excessive polling frequency to prevent hitting API rate limits.
If the node throws errors related to missing parameters or network failures, review the input properties and API credentials.
Links and References
- HeyGen API Documentation (general reference for API endpoints and usage)
- n8n documentation on Creating Custom Nodes