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

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