TypeScript SDK Guide

1
import { SyncClient } from "@sync.so/sdk";
2
3
// Reads SYNC_API_KEY from environment
4
const sync = new SyncClient();
5
6
// Or pass it directly
7
const sync = new SyncClient({ apiKey: "your-api-key" });

1
const response = await sync.generations.create({
2
    input: [
3
        { type: "video", url: "https://your-cdn.com/video.mp4" },
4
        { type: "audio", url: "https://your-cdn.com/audio.wav" },
5
    ],
6
    model: "lipsync-2",
7
    options: { sync_mode: "cut_off" },
8
    outputFileName: "my-output",
9
});

1
const response = await sync.generations.create({
2
    input: [
3
        {
4
            type: "video",
5
            url: "https://your-cdn.com/video.mp4",
6
        },
7
        {
8
            type: "text",
9
            provider: {
10
                name: "elevenlabs",
11
                voiceId: "EXAVITQu4vr4xnSDxMaL",
12
                script: "Your script goes here. Max 5,000 characters per generation.",
13
                stability: 0.5,
14
                similarityBoost: 0.75,
15
            },
16
        },
17
    ],
18
    model: "lipsync-2",
19
    options: { sync_mode: "cut_off" },
20
});

1
// With webhooks, pass a URL when creating the generation
2
const response = await sync.generations.create({
3
    input: [
4
        { type: "video", url: "https://your-cdn.com/video.mp4" },
5
        { type: "audio", url: "https://your-cdn.com/audio.wav" },
6
    ],
7
    model: "lipsync-2",
8
    webhookUrl: "https://your-app.com/api/sync-webhook",
9
});
10
11
// No polling needed -- your webhook endpoint receives the result

1
const generations = await sync.generations.list();
2
3
for (const gen of generations) {
4
    console.log(`${gen.id} - ${gen.status}`);
5
}

1
const generation = await sync.generations.get("generation-id");
2
3
console.log(`Status: ${generation.status}`);
4
console.log(`Output: ${generation.outputUrl}`);
5
console.log(`Model: ${generation.model}`);

1
const estimate = await sync.generations.estimateCost({
2
    input: [
3
        { type: "video", url: "https://your-cdn.com/video.mp4" },
4
        { type: "audio", url: "https://your-cdn.com/audio.wav" },
5
    ],
6
    model: "lipsync-2",
7
});
8
9
console.log(`Estimated cost: ${estimate.totalCredits} credits`);

1
const response = await sync.generations.create({
2
    input: [
3
        { type: "video", url: "https://your-cdn.com/video.mp4" },
4
        { type: "audio", url: "https://your-cdn.com/audio.wav" },
5
    ],
6
    model: "lipsync-2",
7
});

1
// 1. List your uploaded assets
2
const assets = await sync.assets.list();
3
4
// 2. Use an asset URL in a generation
5
const response = await sync.generations.create({
6
    input: [
7
        { type: "video", url: assets[0].url },
8
        { type: "audio", url: "https://your-cdn.com/audio.wav" },
9
    ],
10
    model: "lipsync-2",
11
});

1
import { SyncClient, SyncError } from "@sync.so/sdk";
2
3
const sync = new SyncClient();
4
5
async function createGeneration() {
6
    try {
7
        const response = await sync.generations.create({
8
            input: [
9
                { type: "video", url: "https://your-cdn.com/video.mp4" },
10
                { type: "audio", url: "https://your-cdn.com/audio.wav" },
11
            ],
12
            model: "lipsync-2",
13
        });
14
        return response.id;
15
    } catch (err) {
16
        if (err instanceof SyncError) {
17
            console.error(`API error ${err.statusCode}: ${JSON.stringify(err.body)}`);
18
19
            // Retry on transient errors (5xx)
20
            if (err.statusCode >= 500) {
21
                console.log("Retrying in 5 seconds...");
22
                await new Promise((r) => setTimeout(r, 5000));
23
                return createGeneration();
24
            }
25
        }
26
        throw err;
27
    }
28
}

1
import { SyncClient } from "@sync.so/sdk";
2
import type { Sync } from "@sync.so/sdk";
3
4
const sync = new SyncClient();
5
6
async function processGeneration(jobId: string): Promise<void> {
7
    const generation = await sync.generations.get(jobId);
8
9
    // generation is fully typed -- your editor provides autocomplete
10
    // for properties like .status, .outputUrl, .model, .id, etc.
11
    if (generation.status === "COMPLETED") {
12
        await downloadVideo(generation.outputUrl!);
13
    }
14
}