Actions15
Overview
This node interacts with the HeyGen API to manage and manipulate photo avatars, specifically focusing on avatar groups and their training status. The "Get Training Status" operation retrieves the current status of a training job for a specified avatar group. This is useful in workflows where you need to monitor the progress of machine learning or AI model training related to avatar customization or generation.
Practical scenarios include:
- Automatically checking if an avatar group’s training process has completed before triggering subsequent steps like generating new avatar looks.
- Integrating avatar training status checks into larger automation pipelines for avatar creation and management.
- Monitoring training jobs to provide real-time updates or notifications within an application.
Properties
| Name | Meaning |
|---|---|
| Group ID | ID of the avatar group whose training status you want to retrieve |
Output
The output JSON contains the response from the HeyGen API endpoint that provides the training job status for the specified avatar group. This typically includes fields indicating whether the training is still in progress, completed successfully, or failed, along with any relevant metadata about the training job.
The exact structure depends on the HeyGen API but generally includes:
- Status indicators (e.g., "in_progress", "completed", "failed")
- Timestamps or duration of the training job
- Any error messages or logs if the training failed
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the HeyGen API via an API key credential configured in n8n.
- The node uses the HeyGen API version 2 endpoints.
- Network access to HeyGen API endpoints must be available.
Troubleshooting
Common issues:
- Invalid or missing Group ID: Ensure the Group ID provided exists and is correct.
- API authentication errors: Verify that the API key credential is valid and has necessary permissions.
- Network connectivity problems: Confirm that your environment can reach the HeyGen API servers.
Error messages:
"No binary data exists on item!"or similar will not occur here since this operation does not use binary data.- API errors returned by HeyGen (e.g., 404 Not Found if the group ID does not exist) should be checked and handled accordingly.
- If the node throws an error about missing parameters, ensure the required "Group ID" property is set.
Links and References
- HeyGen API Documentation (general reference for API endpoints)
- n8n documentation on creating custom nodes (for understanding node implementation)