@teamduality/heygen-typescript-sdk NPM

@teamduality/heygen-typescript-sdk

A TypeScript SDK for the HeyGen API, providing a simple interface for AI video generation and avatar management.

Installation

pnpm add @teamduality/heygen-typescript-sdk

Usage

import { HeygenSDK } from '@teamduality/heygen-typescript-sdk'

// Initialize the SDK with your API key
const sdk = new HeygenSDK('your_api_key')

// Create a video
const video = await sdk.videos.create({
  background: '#ffffff',
  clips: [
    {
      avatar_id: 'your_avatar_id',
      input_text: 'Hello world!',
      voice_id: 'your_voice_id'
    }
  ]
})

// Get video status
const status = await sdk.videos.getStatus(video.video_id)

// Get avatar list
const avatars = await sdk.avatars.list()

// Create a streaming session
const session = await sdk.streaming.create({
  avatar_id: 'your_avatar_id',
  quality: 'medium'
})

// Generate a photo avatar
const photo = await sdk.photoAvatars.generatePhoto({
  name: 'Business Professional',
  age: 'Young Adult',
  gender: 'Woman',
  ethnicity: 'Asian American',
  orientation: 'square',
  pose: 'half_body',
  style: 'Realistic',
  appearance: 'A professional woman in a business suit'
})

// Create a photo avatar group
const group = await sdk.photoAvatars.createGroup({
  name: 'Business Team',
  image_key: 'image/key/here'
})

// Add motion to a photo avatar
const motionAvatar = await sdk.photoAvatars.addMotion({
  id: 'photo-avatar-id'
})

Features

Video Generation

Create videos with multiple clips
Support for avatars and talking photos
Background customization
Video status tracking
WebM videos with transparent background

Avatar Management

List available avatars
Create custom avatars
Modify avatar settings
Manage avatar groups
List avatars in groups
Photo avatar generation and management
- Generate photo avatars from descriptions
- Create and manage photo avatar groups
- Add and customize looks
- Add motion and sound effects
- Upscale photo quality