HeyGen is an innovative video platform that harnesses the power of generative AI to streamline your video creation process
Tools
Add New Asset
Creates a new asset in the heygen platform. this endpoint allows users to add various types of assets that can be used in video generation, such as avatars, backgrounds, or other content elements. the asset is created by sending plain text data, which likely includes necessary metadata or configuration information. this tool should be used when integrating new assets into the heygen ecosystem for use in content creation workflows. it's important to note that this endpoint may not support direct file uploads; instead, it might expect references to pre-uploaded files or configuration data for asset creation.
Add Contact To Personalized Video Project
This endpoint allows you to add one or more contacts to a specific personalized video project in the heygen platform. it is used when you need to associate individual contact information with a project, likely for the purpose of creating tailored video content for each contact. the endpoint accepts a project identifier and a list of contacts, each with a first name and email address. this tool is essential for populating your project with recipient data, enabling the creation of personalized videos at scale. note that this endpoint only adds contacts to a project; it does not initiate video creation or sending. ensure that your project id is valid and that all contact information is accurate to avoid errors in video personalization or delivery.
Retrieve Audience Video Details
Retrieves detailed information about the audience for personalized videos. this endpoint provides insights into the target audience characteristics, preferences, and engagement metrics for heygen's ai-generated personalized video content. it can be used to gain a deeper understanding of the audience demographics, behavior patterns, and content preferences to optimize video creation and targeting strategies. the tool is particularly useful for content creators, marketers, and businesses looking to tailor their video content to specific audience segments using heygen's ai capabilities.
Fetch Personalized Video Project Detail
Retrieves detailed information about a specific personalized video project in the heygen platform. this endpoint allows you to fetch comprehensive data about a project, including its current status, configuration settings, and any other relevant metadata. use this when you need to get an up-to-date overview of a particular video project, such as checking its progress, reviewing its settings, or gathering information for reporting purposes. the endpoint is read-only and does not modify any project data. note that it may not include the actual video content itself, but rather focuses on the project's attributes and status.
Post Talking Photo Binary Image
Creates a talking photo by processing an uploaded image file. this endpoint enables users to transform static images into interactive, speaking visual content using heygen's advanced ai technology. it accepts jpeg or png image files and likely combines them with audio narration (though audio input is not specified in this schema). use this endpoint when you want to generate engaging, personalized content from still images, such as creating speaking avatars or animated photographs. the endpoint is particularly useful for marketing materials, educational content, or personalized messages. note that while image upload is specified, the method for providing or generating the associated audio is not detailed in this schema.
List Streaming Avatars
Retrieves a list of available avatars for streaming purposes in the heygen platform. this endpoint allows developers to access the collection of realistic avatars that can be used for creating professional-looking videos with ai-generated content. it's designed to support applications requiring dynamic or live video content, enabling real-time access to the avatar library. the endpoint should be used when you need to fetch the current set of available avatars for integration into streaming or video generation workflows. it may not provide detailed information about each avatar's capabilities or customization options, focusing instead on delivering a quick, up-to-date list for immediate use in streaming contexts.