heygen-avatars

# HeyGen Avatars

AI avatar video creation using HeyGen API for talking head videos, avatar generation, and text-to-video workflows.

## Quick Start

```typescript
// Check remaining quota
const response = await fetch("https://api.heygen.com/v2/user/remaining_quota", {
  headers: { "X-Api-Key": process.env.HEYGEN_API_KEY! }
});

// Generate avatar video
const video = await fetch("https://api.heygen.com/v2/video/generate", {
  method: "POST",
  headers: {
    "X-Api-Key": process.env.HEYGEN_API_KEY!,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    video_inputs: [{
      character: { type: "avatar", avatar_id: "your-avatar-id" },
      voice: { type: "text", input_text: "Hello world!", voice_id: "your-voice-id" }
    }],
    dimension: { width: 1280, height: 720 }
  })
});
```

## When to use

Use this skill whenever you are dealing with HeyGen API code to obtain domain-specific knowledge for creating AI avatar videos, managing avatars, handling video generation workflows, and integrating with HeyGen's services.

## How to use

Read individual rule files for detailed explanations and code examples:

### Foundation
- [rules/authentication.md](rules/authentication.md) - API key setup, X-Api-Key header, and authentication patterns
- [rules/quota.md](rules/quota.md) - Credit system, usage limits, and checking remaining quota
- [rules/video-status.md](rules/video-status.md) - Polling patterns, status types, and retrieving download URLs
- [rules/assets.md](rules/assets.md) - Uploading images, videos, and audio for use in video generation

### Core Video Creation
- [rules/avatars.md](rules/avatars.md) - Listing avatars, avatar styles, and avatar_id selection
- [rules/voices.md](rules/voices.md) - Listing voices, locales, speed/pitch configuration
- [rules/scripts.md](rules/scripts.md) - Writing scripts, pauses/breaks, pacing, and structure templates
- [rules/video-generation.md](rules/video-generation.md) - POST /v2/video/generate workflow and multi-