Overview

This node operation checks the status of a photo avatar generation job using the HeyGen API. It is useful for monitoring the progress or completion of avatar photo generation tasks initiated earlier. For example, after requesting a photo avatar generation, you can use this operation to poll the status by providing the generation job ID.

Use Case Examples

1. Check the status of a photo avatar generation job by providing its generation ID to see if the avatar is ready or still processing.
2. Monitor multiple avatar generation jobs by repeatedly checking their statuses to automate workflows dependent on avatar availability.

Properties

Output

JSON

• status - The current status of the photo avatar generation job (e.g., pending, completed, failed).
• generationId - The ID of the generation job checked.
• details - Additional details or metadata about the generation status returned by the API.

Dependencies

• HeyGen API with an API key credential for authentication

Troubleshooting

• Ensure the Generation ID provided is correct and corresponds to an existing generation job; otherwise, the API may return an error or no data.
• Check network connectivity and API authentication credentials if the request fails to reach the HeyGen API.
• If the generation status is not updating, verify that the generation job was successfully initiated before checking its status.

Links

• HeyGen API Photo Avatar Generation Status - Official API documentation for checking the status of photo avatar generation jobs.