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 Custom Events Options:
const result = await mcp.callTool({
name: "heygen-list-custom-events-options",
arguments: {},
})# 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 Custom Events Options:
result = await session.call_tool("heygen-list-custom-events-options", {})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 Custom Events 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-custom-events-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
heygen: { authProvisionId: "apn_xxxxxxx" },
},
})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-custom-events-options",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"heygen": {"authProvisionId": "apn_xxxxxxx"},
},
)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-custom-events-options",
"configured_props": {
"heygen": { "authProvisionId": "apn_xxxxxxx" }
}
}'TOOLS
HeyGen actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
List Custom Events Options
actionRetrieves available options for the Custom Events field.Read-onlyv0.0.1 -
List Talking Photo ID Options
actionRetrieves available options for the Talking Photo ID field.Read-onlyv0.0.1 -
List Template ID Options
actionRetrieves available options for the Template ID field.Read-onlyv0.0.1 -
List Voice ID Options
actionRetrieves available options for the Voice ID field.Read-onlyv0.0.1 -
Retrieve Video Link
actionFetches a link for a specific heygen video. See the documentationRead-onlyv0.0.2
-
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.1 -
New Avatar Video Failure (Instant)
triggerEmit new event when a Heygen video fails during processing. See the documentationInstantv0.0.1 -
New Avatar Video Success (Instant)
triggerEmit new event when a new avatar video has been successfully generated. See the documentationInstantv0.0.1
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
- 5
- Triggers
- 3
- API proxy
- Available