Quickstart

1
import time
2
from sync import Sync
3
from sync.common import Audio, GenerationOptions, Video
4
from sync.core.api_error import ApiError
5
6
# ----------[OPTIONAL] UPDATE INPUT VIDEO AND AUDIO URL ----------
7
# URL to your source video
8
video_url = "https://assets.sync.so/docs/example-video.mp4"
9
# URL to your audio file
10
audio_url = "https://assets.sync.so/docs/example-audio.wav"
11
# ----------------------------------------
12
13
sync = Sync()
14
15
print("Starting lip sync generation job...")
16
17
try:
18
    response = sync.generations.create(
19
        input=[Video(url=video_url),Audio(url=audio_url)],
20
        model="lipsync-2",
21
        options=GenerationOptions(sync_mode="cut_off"),
22
        output_file_name="quickstart"
23
    )
24
except ApiError as e:
25
    print(f'create generation request failed with status code {e.status_code} and error {e.body}')
26
    exit()
27
28
job_id = response.id
29
print(f"Generation submitted successfully, job id: {job_id}")
30
31
generation = sync.generations.get(job_id)
32
status = generation.status
33
while status not in ['COMPLETED', 'FAILED', 'REJECTED']:
34
    print('polling status for generation', job_id)
35
    time.sleep(10)
36
    generation = sync.generations.get(job_id)
37
    status = generation.status
38
39
if status == 'COMPLETED':
40
    print('generation', job_id, 'completed successfully, output url:', generation.output_url)
41
else:
42
    print('generation', job_id, 'failed')

1
import { SyncClient, SyncError } from "@sync.so/sdk";
2
3
// ----------[OPTIONAL] UPDATE INPUT VIDEO AND AUDIO URL ----------
4
// URL to your source video
5
const videoUrl = "https://assets.sync.so/docs/example-video.mp4";
6
// URL to your audio file
7
const audioUrl = "https://assets.sync.so/docs/example-audio.wav";
8
// ----------------------------------------
9
10
const sync = new SyncClient();
11
12
async function main() {
13
    console.log("Starting lip sync generation job...");
14
15
    let jobId: string;
16
    try {
17
        const response = await sync.generations.create({
18
            input: [
19
                {
20
                    type: "video",
21
                    url: videoUrl,
22
                },
23
                {
24
                    type: "audio",
25
                    url: audioUrl,
26
                },
27
            ],
28
            model: "lipsync-2",
29
            options: {
30
                sync_mode: "cut_off",
31
            },
32
            outputFileName: "quickstart"
33
        });
34
        jobId = response.id;
35
        console.log(`Generation submitted successfully, job id: ${jobId}`);
36
    } catch (err) {
37
        if (err instanceof SyncError) {
38
            console.error(`create generation request failed with status code ${err.statusCode} and error ${JSON.stringify(err.body)}`);
39
        } else {
40
            console.error('An unexpected error occurred:', err);
41
        }
42
        return;
43
    }
44
45
    let generation;
46
    let status;
47
    while (status !== 'COMPLETED' && status !== 'FAILED' && status !== 'REJECTED') {
48
        console.log(`polling status for generation ${jobId}...`);
49
        try {
50
            await new Promise(resolve => setTimeout(resolve, 10000));
51
            generation = await sync.generations.get(jobId);
52
            status = generation.status;
53
        } catch (err) {
54
            if (err instanceof SyncError) {
55
                console.error(`polling failed with status code ${err.statusCode} and error ${JSON.stringify(err.body)}`);
56
            } else {
57
                console.error('An unexpected error occurred during polling:', err);
58
            }
59
            status = 'FAILED';
60
        }
61
    }
62
63
    if (status === 'COMPLETED') {
64
        console.log(`generation ${jobId} completed successfully, output url: ${generation?.outputUrl}`);
65
    } else {
66
        console.log(`generation ${jobId} failed`);
67
    }
68
}
69
70
main();