CONNECT APP
Build with HeyGen
Artificial Intelligence (AI)
- API key
MCP
Give your agent HeyGen tools
Every HeyGen action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's HeyGen account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "heygen",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run List Avatar Look ID Options:
const result = await mcp.callTool({
name: "heygen-list-avatar-look-id-options",
arguments: {
avatarType: "Avatar Type",
ownership: "Ownership",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "heygen",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run List Avatar Look ID Options:
result = await session.call_tool("heygen-list-avatar-look-id-options", {
"avatarType": "Avatar Type",
"ownership": "Ownership",
})API PROXY
Call the HeyGen API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the HeyGen API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.heygen.com/v2/avatars",
})
// Any allowed HeyGen endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.heygen.com/v2/avatars
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuaGV5Z2VuLmNvbS92Mi9hdmF0YXJz?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run HeyGen actions from your backend
Connect a user's HeyGen account once, then run List Avatar Look ID Options on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "heygen-list-avatar-look-id-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
heygen: { authProvisionId: "apn_xxxxxxx" },
avatarType: "Avatar Type",
ownership: "Ownership",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="heygen-list-avatar-look-id-options",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"heygen": {"authProvisionId": "apn_xxxxxxx"},
"avatarType": "Avatar Type",
"ownership": "Ownership",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "heygen-list-avatar-look-id-options",
"configured_props": {
"heygen": { "authProvisionId": "apn_xxxxxxx" },
"avatarType": "Avatar Type",
"ownership": "Ownership"
}
}'TOOLS
HeyGen actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
List Avatar Look ID Options
actionRetrieves a page of available avatar looks, whoseidcan be used for Avatar Look ID fields. Listsphoto_avatarlooks by default; set Avatar Type todigital_twinorstudio_avatarfor other kinds, and Ownership topublicorprivateto narrow further. Pass Fields to keep the response small. Ifhas_moreis true, passnext_tokenas the Token to get the next page. Example: Limit2and Fields["id", "name"]returns{"data": [{"id": "look_1", "name": "Office look"}, {"id": "look_2", "name": "Outdoor look"}], "has_more": true, "next_token": "abc"}. See the documentationRead-onlyv0.0.1 -
List Custom Events Options
actionRetrieves all available webhook event types, whoseevent_typecan be used for Custom Events fields. The full list is returned in a single response (no paging). Example: returns{"data": [{"event_type": "avatar_video.success", "description": "Fires when an avatar video finishes"}]}. See the documentationRead-onlyv1.0.0 -
List Talking Photo ID Options
actionRetrieves available options for the Talking Photo ID field.Read-onlyv0.0.1 -
List Template ID Options
actionRetrieves a page of available templates, whoseidcan be used for Template ID fields. Ifhas_moreis true, passnext_tokenas the Token to get the next page. Example: Limit2returns{"data": [{"id": "tpl_1", "name": "Product launch", "aspect_ratio": "16:9"}, {"id": "tpl_2", "name": "Weekly update", "aspect_ratio": "9:16"}], "has_more": true, "next_token": "abc"}. See the documentationRead-onlyv1.0.0 -
List Videos
actionRetrieves a page of videos, newest first, with theirid,status, and download links once completed. Use this to find a video ID for other actions. Note: the HeyGen v3 list may not include videos created in the HeyGen web app (it can return an empty list even when such videos exist); if you already know a video's ID, use Retrieve Video Link instead, which works for any video ID. Pass Fields to keep the response small. Ifhas_moreis true, passnext_tokenas the Token to get the next page. Example: TitleOnboardingwith Limit2and Fields["id", "title", "status"]returns{"data": [{"id": "v_123", "title": "Onboarding intro", "status": "completed"}, {"id": "v_122", "title": "Onboarding part 2", "status": "processing"}], "has_more": true, "next_token": "abc"}. See the documentationRead-onlyv0.0.1 -
List Voice ID Options
actionRetrieves a page of available voices, whosevoice_idcan be used for Voice ID fields. Lists public voices by default; set Voice Type toprivateto list your own cloned voices, and use Language and Gender to narrow results instead of paging through every voice. Ifhas_moreis true, passnext_tokenas the Token to get the next page. Example: LanguageSpanish, Genderfemaleand Limit2returns{"data": [{"voice_id": "voice_1", "name": "Camila", "language": "Spanish", "gender": "female"}, {"voice_id": "voice_2", "name": "Lucia", "language": "Spanish", "gender": "female"}], "has_more": true, "next_token": "abc"}. See the documentationRead-onlyv1.0.0 -
Retrieve Video Link
actionFetches a link for a specific heygen video. The link is only available once the video status iscompleted. Works for any video ID, including videos created in the HeyGen web app. If you don't have the video ID, use the List Videos action first (note it may not list web-app videos). Example: Video IDv_123returns{"data": {"id": "v_123", "status": "completed", "video_url": "https://..."}, "video_link": "https://..."}; while the video is still processing,video_linkis null anddata.statusisprocessing(check again later). If generation failed,data.statusisfailed,video_linkis null, andfailure_codeandfailure_messageexplain why; the video will never complete, so do not keep polling. See the documentationRead-onlyv1.0.0
-
New Avatar Video Custom Event (Instant)
triggerEmit new event when a specific avatar video event occurs. The user can define a custom set of event(s) to trigger. See the documentationInstantv0.0.2 -
New Avatar Video Failure (Instant)
triggerEmit new event when a Heygen video fails during processing. See the documentationInstantv0.0.2 -
New Avatar Video Success (Instant)
triggerEmit new event when a new avatar video has been successfully generated. See the documentationInstantv0.0.2
MULTI-APP
Use HeyGen with other popular apps
Most products don't stop at one integration. Pair HeyGen with the other apps your users rely on, and ship use cases that span both.
- App slug
- heygen
- Authentication
- API key
- Categories
- Artificial Intelligence (AI)
- Actions
- 7
- Triggers
- 3
- API proxy
- Available