HeyGen integration

Act in HeyGen (35)

Runs only after you enable write access.

• 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.

• Personalized video add contact

  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.

• Personalized video audience detail

  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.

• 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.

• Streaming avatar list

  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.

• Streaming create token

  Creates a new streaming token for use with heygen's real-time avatar and voice chat services. this endpoint generates a unique, time-limited token that authenticates and authorizes access to heygen's streaming capabilities. use this endpoint when initiating a new streaming session or when the previous token has expired. the generated token is typically for one-time use and should be obtained shortly before starting a streaming interaction. note that this endpoint does not initiate the streaming itself; it only provides the necessary credentials for subsequent streaming api calls.

• Streaming ice

  This endpoint is used to submit ice (interactive connectivity establishment) candidate information for a specific streaming session in the heygen platform. it plays a crucial role in establishing and managing peer-to-peer connections for real-time communication and streaming of avatar content. the endpoint should be called when new ice candidates are discovered during the connection setup process, typically as part of the webrtc negotiation. it's essential for ensuring optimal connectivity between clients, especially in scenarios involving nat traversal or complex network environments. this endpoint does not return the status of the connection or initiate the streaming itself; it only submits candidate information to be used in the connection process.

• Streaming interrupt

  Interrupts an ongoing streaming session with an interactive avatar. this endpoint allows immediate termination of the avatar's current action or speech, providing control over the flow of interaction. use this when you need to abruptly stop the avatar's current behavior, such as when changing topics or responding to user input that requires a different response. the interruption is immediate and irreversible, so use it judiciously to maintain a smooth user experience. this endpoint is particularly useful in scenarios where real-time responsiveness is crucial, like in customer service applications or interactive presentations.

• Streaming list

  Retrieves a list of active or available streaming sessions or content within the heygen platform. this endpoint allows users to get an overview of ongoing streams, which may include live avatar interactions, real-time video generations, or other streaming content created using heygen's ai-driven tools. it's particularly useful for monitoring current streaming activities or checking the availability of streams for integration into applications. the endpoint returns basic information about each stream, such as stream ids, status, and possibly metadata, but does not provide the actual stream content. use this when you need to track or display a list of active streams in your application's interface or for administrative purposes.

• Streaming new

  Initiates a new streaming session with heygen, allowing users to start an avatar-based stream with specified quality settings. this endpoint should be used when starting a new interactive content session or when creating a personalized digital avatar stream. it sets up the initial configuration for the streaming quality, which affects the overall user experience and bandwidth usage. the endpoint does not handle the actual streaming content or avatar creation; it only establishes the session parameters.

• Streaming start

  Initiates a new streaming session for real-time communication in the heygen platform. this endpoint is used to set up a webrtc connection for video, audio, and data streaming, likely for interactions with ai avatars. it requires a unique session id and a session description protocol (sdp) offer to establish the connection. this endpoint should be called when starting a new interactive session with a heygen ai avatar or when initiating a live streaming event. it's crucial for setting up the initial parameters of the real-time communication channel.

and 23 more.