Skip to content
Synthesia SDK

Synthesia SDK Documentation

Create AI-generated videos programmatically with TypeScript
Get Started View on GitHub

Features

🎬 Video Creation

Create AI-generated videos with custom scripts, avatars, and backgrounds

📋 Template System

Use pre-designed templates for scalable video personalization

🔔 Real-time Webhooks

Get instant notifications when videos complete processing

📁 Asset Management

Upload custom audio, images, and videos for your content

⚡ TypeScript First

Full TypeScript support with complete type definitions

🛡️ Error Handling

Robust error handling with retry logic and rate limiting

Quick Start

Get up and running in minutes:

Terminal window
npm install @androettop/synthesia-sdk
import { Synthesia } from '@androettop/synthesia-sdk';


const synthesia = new Synthesia({
  apiKey: 'your-api-key-here',
});


// Create your first video
const video = await synthesia.videos.createVideo({
  title: 'My First Video',
  scriptText: 'Hello, World! This is my first synthetic video!',
  avatar: 'anna_costume1_cameraA',
  background: 'green_screen',
  test: true,
});


console.log('Video created:', video.data?.id);

What’s Included

Complete API Coverage

Videos, Templates, Webhooks, and Uploads APIs fully implemented

Production Ready

Rate limiting, error handling, and retry logic built-in

Developer Experience

IntelliSense, type safety, and comprehensive documentation

Official API Documentation

This SDK documentation is based on the official Synthesia API documentation:

Each section includes:

  • ✅ Complete code examples
  • ✅ TypeScript type definitions
  • ✅ Error handling patterns
  • ✅ Links to official API documentation
  • ✅ Best practices and tips

Next Steps

Ready to start creating videos? Choose your path: