View as Markdown
HeyGen icon

HeyGen ACTION

List Voice ID Options

Retrieves a page of available voices, whose voice_id can be used for Voice ID fields. Lists public voices by default; set Voice Type to private to list your own cloned voices, and use Language and Gender to narrow results instead of paging through every voice. If has_more is true, pass next_token as the Token to get the next page. Example: Language Spanish, Gender female and Limit 2 returns {"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 documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HeyGen account once, then configure and run List Voice ID Options from your backend or agent.

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-voice-id-options",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heygen: { authProvisionId: "apn_xxxxxxx" },
    type: "Voice Type",
    language: "Language",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Voice ID Options inputs
Property Type Description
type Voice Type string
public for the shared voice library, or private for your own cloned voices. Defaults to public if not set. Example: private
Optional
language Language string
Only return voices in this language, given as its English name. Example: Spanish
Optional
gender Gender string
Only return voices of this gender. Example: female
Optional
limit Limit integer
Number of results per page (1-100). Defaults to the API default if not set. Example: 20
Optional
token Token string
Cursor for the next page. Use the next_token value from the previous response of this same action, with the same filters and limit. Example: eyJzdGFydF9pZCI6ICI4NDU5MTlhZTEw...
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
heygen-list-voice-id-options
Version
1.0.0
App
HeyGen
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes