View as Markdown
HeyGen icon

HeyGen ACTION

List Avatar Look ID Options

Retrieves a page of available avatar looks, whose id can be used for Avatar Look ID fields. Lists photo_avatar looks by default; set Avatar Type to digital_twin or studio_avatar for other kinds, and Ownership to public or private to narrow further. Pass Fields to keep the response small. If has_more is true, pass next_token as the Token to get the next page. Example: Limit 2 and 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 documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HeyGen account once, then configure and run List Avatar Look 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-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",
  },
})

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 Avatar Look ID Options inputs
Property Type Description
avatarType Avatar Type string
Type of avatar looks to list: photo_avatar (photo-based avatars), digital_twin (avatars cloned from video footage), or studio_avatar (preset studio avatars). Defaults to photo_avatar. Example: photo_avatar
Optional
ownership Ownership string
Filter by ownership: public for HeyGen's preset avatars, or private for your own. Returns both if not set. Example: private
Optional
avatarLookFields Fields string[]
Only return these fields for each avatar look, to keep the response small. Valid fields: id, name, avatar_type, group_id, preview_image_url, preview_video_url, gender, tags, default_voice_id, status, supported_api_engines (the video generation engines this look works with, e.g. ["avatar_v", "avatar_iv", "avatar_iii"]), image_width and image_height (source image size in pixels, e.g. 1920 x 1080), and preferred_orientation (landscape or portrait, the orientation this look is best suited to). Example: ["id", "name"]. Returns all fields if not set.
Optional
limit Limit integer
Number of results per page (1-50). 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-avatar-look-id-options
Version
0.0.1
App
HeyGen
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes