How to integrate Heygen MCP with OpenAI Agents SDK

Trusted by
AWS
Glean
Zoom
Airtable

30 min · no commitment · see it on your stack

Heygen logo
OpenAI Agents SDK logo
divider

Introduction

This guide walks you through connecting Heygen to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Heygen agent that can create a talking photo from your selfie, add new contacts to your video project, list all available streaming avatars for today through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Heygen account through Composio's Heygen MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Heygen with

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Heygen
  • Configure an AI agent that can use Heygen as a tool
  • Run a live chat session where you can ask the agent to perform Heygen operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

What is the Heygen MCP server, and what's possible with it?

The Heygen MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Heygen account. It provides structured and secure access to your Heygen video platform, so your agent can perform actions like creating talking photos, managing video assets, personalizing video projects, and controlling streaming avatars on your behalf.

  • AI-powered video asset creation: Add new avatars, backgrounds, or other content elements directly into your Heygen library for use in video generation workflows.
  • Personalized video project management: Let your agent add contacts to personalized video projects and fetch detailed project information to streamline large-scale video personalization efforts.
  • Dynamic talking photo generation: Instantly create engaging talking photos from uploaded images, transforming static pictures into interactive, speaking content for marketing or educational use.
  • Real-time avatar streaming control: Retrieve a list of streaming avatars, generate streaming tokens, and manage live avatar sessions—including interrupting or monitoring ongoing streams for responsive, interactive experiences.
  • Audience insights and analytics: Fetch detailed audience engagement and preference data for personalized video campaigns, helping you optimize your content and targeting strategies.

Supported Tools & Triggers

Tools
Add looks to photo avatar groupTool to add additional looks (images) to an existing photo avatar group.
Add motion to photo avatarTool to add natural motion or animation to an existing photo avatar, turning a still image into a moving, lifelike one.
Check photo/look generation statusTool to retrieve the current status and details of a photo avatar or look generation by its ID.
Create a new folderTool to create a new folder under your HeyGen account.
Create knowledge baseTool to create a new knowledge base with a specified name, opening line, and custom prompt for Interactive Avatar streaming sessions.
Create photo avatar groupTool to create an avatar group which can include both AI-generated and user-uploaded photos of the avatar.
Create WebM videoTool to create a WebM format video with transparent background featuring an avatar speaking text or audio.
Delete an avatar videoTool to delete a video by its ID from HeyGen account.
Delete assetTool to delete a specific asset by its unique asset ID from HeyGen account.
Delete knowledge baseTool to delete a specific knowledge base by its ID.
Delete photo avatarTool to delete a photo avatar by its ID from HeyGen account.
Delete photo avatar groupTool to delete a photo avatar group by its ID from HeyGen account.
Delete webhook endpointTool to permanently delete a webhook endpoint from HeyGen.
Generate photo avatar photosTool to generate a personalized AI avatar based on text prompts and attribute inputs.
Generate text-to-speech audioTool to generate a speech audio file from any text input using a specified voice, powered by HeyGen's Starfish model.
Generate voice audio previewTool to generate a short audio preview with the specified voice and text.
Get current user informationTool to retrieve the profile information of the currently authenticated user.
Get training job statusTool to retrieve the current training status and details of a photo avatar training job by group ID.
Keep alive streaming sessionTool to reset the idle timeout counter for an active streaming session.
List all avatar groupsTool to retrieve a list of all available avatar groups in your HeyGen account.
List all locales for voicesTool to retrieve available locales for multilingual voices.
List assetsTool to retrieve a paginated list of all assets (images, audios, videos) created under your account.
List brand voicesTool to retrieve a list of brand glossaries created under your account.
List foldersTool to retrieve a paginated list of folders created under your account.
List avatars in a specific groupTool to retrieve all avatars that belong to a specific avatar group.
List knowledge basesTool to retrieve a list of all existing knowledge bases associated with your account.
List session historyTool to retrieve a paginated history of all streaming sessions with metadata including session duration, timestamps, and other details.
List streaming avatarsTool to retrieve a list of public and custom interactive avatars for streaming.
List TTS voicesTool to retrieve a list of public and custom voices compatible with HeyGen's Starfish TTS model.
Create new streaming sessionTool to initiate a new streaming session with an Interactive Avatar for real-time interactions.
Add contact to personalized video projectThis endpoint allows you to add one or more contacts to a specific personalized video project in the Heygen platform.
Fetch personalized video project detailRetrieves detailed information about a specific personalized video project in HeyGen, including status, settings, and metadata.
Get photo avatar detailsTool to retrieve detailed information about a photo avatar or look using its unique ID.
Post talking photo binary imageCreates a talking photo by processing an uploaded image file.
Restore folder from trashTool to restore a previously deleted folder from trash by its unique folder ID.
Retrieve avatar detailsTool to retrieve detailed information about a specific avatar by its ID.
Retrieve sharable video URLTool to generate a public, shareable URL for a specific video by ID.
Retrieve template details v3Tool to retrieve comprehensive details about a specific template including all available variables for replacement and scene mappings for templates built in the New AI Studio.
Retrieve video status detailsTool to retrieve the current processing status and metadata for a specific video by ID.
Search public avatar groupsTool to search and retrieve public avatar groups with optional filters and pagination.
Create streaming token with expiryCreates a new streaming token for use with HeyGen's real-time avatar and voice chat services.
Post streaming ice candidatesThis endpoint is used to submit ICE (Interactive Connectivity Establishment) candidate information for a specific streaming session in the Heygen platform.
Interrupt streaming sessionInterrupts an ongoing streaming session with an interactive avatar.
Retrieve streaming listRetrieves a list of active or available streaming sessions or content within the HeyGen platform.
Set streaming quality endpointInitiates a new streaming session with HeyGen, allowing users to start an avatar-based stream with specified quality settings.
Start streaming sessionInitiates a new streaming session for real-time communication in the HeyGen platform.
Stop streaming sessionThe streaming.
Send task to streaming avatarThe StreamingTask endpoint initiates a real-time speaking task for an AI-driven avatar within an active streaming session.
Move folder to trashTool to move a specific folder to trash by its unique folder ID.
Update folder nameTool to update (rename) an existing folder by its unique folder ID.
Update knowledge baseTool to update an existing knowledge base by its ID.
Update webhook endpointTool to modify an existing webhook endpoint configuration including URL and subscribed event types.
Upload assetTool to upload a file asset (image, video, or audio) to HeyGen platform.
Upscale motion avatarTool to enhance the resolution and visual quality of a motion avatar.
List avatars endpointRetrieves a list of available avatars from the Heygen platform.
List talking photo entriesRetrieves a list of talking photos created using the HeyGen platform.
List videosRetrieves a list of videos associated with the user's account on the HeyGen platform.
List voice endpointsRetrieves a comprehensive list of all available voices in the HeyGen platform.
Add webhook endpointAdds a new webhook endpoint to receive real-time notifications for specified Heygen events.
List webhook endpointsRetrieves a list of all webhook endpoints configured for your HeyGen account.
List webhooksRetrieves a list of all available webhook event types that can be subscribed to in your HeyGen account.
Delete talking photo by idDeletes a specific talking photo from the HeyGen platform using its unique identifier.
Generate video template with variablesGenerates a customized video from a pre-existing template using HeyGen's AI platform.
Get template by idRetrieves a specific template from the HeyGen platform using its unique identifier.
Retrieve all templatesRetrieves a list of available avatar templates from the HeyGen platform.
Retrieve user remaining quotaRetrieves the current remaining quota for the authenticated user on the HeyGen platform.
Generate video with inputsGenerates a customized video using Heygen's AI-driven platform.
Post video translate requestThe TranslateVideo endpoint enables the translation of video content from one language to another.
Retrieve video translation by idRetrieves the current status of a video translation job in the HeyGen platform.
Retrieve video translation target languagesRetrieves a list of all available target languages supported by HeyGen's video translation feature.
List available voicesRetrieves a list of available voice models and options that can be used with HeyGen's AI-driven video creation platform.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Heygen project
  • Some knowledge of Python or Typescript

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Heygen.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Heygen Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["heygen"]
)

mcp_url = session.mcp.url

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only heygen.
  • The router checks the user's Heygen connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Heygen.
  • This approach keeps things lightweight and lets the agent request Heygen tools only when needed during the conversation.

Configure the agent

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Heygen. "
        "Help users perform Heygen operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Heygen and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a HostedMCPTool that connects to the MCP server URL we created earlier.
  • The headers dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Heygen operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
What's happening:
  • The program prints a session URL that you visit to authorize Heygen.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Heygen and OpenAI Agents SDK:

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["heygen"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = Agent(
    name="Assistant",
    model="gpt-5",
    instructions=(
        "You are a helpful assistant that can access Heygen. "
        "Help users perform Heygen operations through natural language."
    ),
    tools=[
        HostedMCPTool(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

Conclusion

This was a starter code for integrating Heygen MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Heygen.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.

How to build Heygen MCP Agent with another framework

FAQ

What are the differences in Tool Router MCP and Heygen MCP?

With a standalone Heygen MCP server, the agents and LLMs can only access a fixed set of Heygen tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Heygen and many other apps based on the task at hand, all through a single MCP endpoint.

Can I use Tool Router MCP with OpenAI Agents SDK?

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Heygen tools.

Can I manage the permissions and scopes for Heygen while using Tool Router?

Yes, absolutely. You can configure which Heygen scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Heygen data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.