—
Sync Lipsync 3 — Video to Video
sync-3 most powerful lipsync model yet, featuring native visual intelligence for professional-quality video.
Input
Add your inputs and customize the generation settings.
Result & Pricing
Video output — your generated video will appear here.
Your video will appear here
Choose your inputs and customize your settings.
Model pricing (tax excluded) per minute
| Specification | Webot INR |
|---|---|
| Rate | ₹958.46 |
Calculate credits in the input panel for your selected settings.
Prices, estimates and credit deductions exclude tax. Any applicable tax is charged only when you buy plans or credits.
Prices are converted to INR. Credits use your current plan rate.
- Prices shown are estimates, not final charges. Final billing details will be available in Reports after generation is complete.
API
WEBOT API · Video to Video
Generate from your server with your WEBOT account credits.
Use your 120-character WEBOT customer key (a–z, A–Z, 0–9). Send
Authorization: Bearer YOUR_KEY. Keys are secrets: call from a server, never from public frontend code. Results come from verified webhooks and remain saved if your stream disconnects.1. Configure your server
WEBOT_BASE_URL=https://webot.online
WEBOT_API_KEY=<your-server-side-WEBOT-key>This base URL is resolved from verified domain mappings and your direct creator reseller. Forwarded Host headers are not trusted. New custom reseller domains need DNS, TLS and platform verification before activation.
2. Quote, then generate
| Method | Endpoint | Purpose |
|---|---|---|
| POST | https://webot.online/api/v1/models/creative_492647f86055b5115d3bc0ff/quote | Validate input and calculate credits (no deduction). |
| POST | https://webot.online/api/v1/models/creative_492647f86055b5115d3bc0ff/requests | Reserve quoted credits and queue an asynchronous job. |
| GET | https://webot.online/api/v1/models/creative_492647f86055b5115d3bc0ff/requests/{request_id}/result | Read your saved result: 202 pending, 200 terminal. |
| GET | https://webot.online/api/v1/models/creative_492647f86055b5115d3bc0ff/requests/{request_id}/events | Authenticated SSE: generation / terminal events. |
Send JSON {"input":{…}} to quote. Send the same input plus integer quoted_credits to generate, with Authorization: Bearer … and Idempotency-Key. Use a unique 16–128 character key per new job; persist it and reuse the same key and input on any uncertain response. Never retry with a new key: that creates a second chargeable job.
Credits are reserved only after validation and a durable request is saved. A changed quote or insufficient balance returns 409. Credits exclude purchase taxes. The quoted amount is an initial reservation. After generation, the final charge replaces it using confirmed usage. Any verified unused allocation becomes available automatically; additional usage may require more credits. Missing billing stays pending, including for failed jobs.
3. Input example
Save this as input.json. Replace sample prompts, files and media URLs with your own. Schemas do not guarantee provider acceptance of the content.
Supported generation options
- Provide source audio for the duration reservation. Your final charge is adjusted after confirmed usage billing.
{
"video_url": "https://example.com/video.mp4",
"audio_url": "https://example.com/source.mp3",
"sync_mode": "cut_off"
}4. Language examples
# Save the model's example input as input.json, then replace prompts/media URLs.
# Requires curl and jq. Store NONCE once for this job; reuse it on any retry.
export NONCE="$(openssl rand -hex 16)"
BASE="${WEBOT_BASE_URL%/}"
jq -n --slurpfile input input.json '{input:$input[0]}' > quote-body.json
curl --fail-with-body -sS "$BASE/api/v1/models/creative_492647f86055b5115d3bc0ff/quote" \
-H "Authorization: Bearer $WEBOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @quote-body.json > quote.json
CREDITS=$(jq -er '.quote.credits_consumed' quote.json)
jq --argjson credits "$CREDITS" '. + {quoted_credits:$credits}' quote-body.json > request-body.json
curl --fail-with-body -sS "$BASE/api/v1/models/creative_492647f86055b5115d3bc0ff/requests" \
-H "Authorization: Bearer $WEBOT_API_KEY" -H "Idempotency-Key: $NONCE" \
-H 'Content-Type: application/json' --data-binary @request-body.json > job.json
# Subscribe; after a nonterminal disconnect, reconnect this SAME URL.
curl --fail-with-body -N "$(jq -er '.events_url' job.json)" -H "Authorization: Bearer $WEBOT_API_KEY"
# Read saved output after terminal notification (never call provider status/results).
curl --fail-with-body -sS "$(jq -er '.result_url' job.json)" -H "Authorization: Bearer $WEBOT_API_KEY"// Node.js 18+. Save your customized input in input.json.
import { readFileSync } from 'node:fs';
import { randomUUID } from 'node:crypto';
const base = process.env.WEBOT_BASE_URL.replace(/\/$/, '');
const key = process.env.WEBOT_API_KEY;
const input = JSON.parse(readFileSync('input.json', 'utf8'));
const nonce = process.env.WEBOT_JOB_NONCE || randomUUID(); // Persist before submission.
async function post(path, body, nonce) {
const response = await fetch(base + path, {method:'POST', headers:{
Authorization:`Bearer ${key}`, 'Content-Type':'application/json',
...(nonce ? {'Idempotency-Key':nonce} : {})}, body:JSON.stringify(body)});
const json = await response.json();
if (!response.ok) throw new Error(JSON.stringify(json));
return json;
}
const {quote} = await post('/api/v1/models/creative_492647f86055b5115d3bc0ff/quote', {input});
const job = await post('/api/v1/models/creative_492647f86055b5115d3bc0ff/requests', {input, quoted_credits:quote.credits_consumed}, nonce);
console.log(job); // Stable WEBOT request_id, events_url, result_url.
// Stream saved webhook state. Reconnect ONLY the event stream, not the generation.
while (!job.terminal || job.financial_pending) {
const stream = await fetch(job.events_url, {headers:{Authorization:`Bearer ${key}`}});
if (!stream.ok) throw new Error(`Event stream HTTP ${stream.status}`);
let buffer = '';
for await (const chunk of stream.body.pipeThrough(new TextDecoderStream())) {
buffer += chunk;
let end;
while ((end = buffer.indexOf('\n\n')) !== -1) {
const event = buffer.slice(0, end); buffer = buffer.slice(end + 2);
const data = event.split('\n').find(line => line.startsWith('data: '));
if (!data) continue;
const state = JSON.parse(data.slice(6));
if (state.error && !state.status) throw new Error(JSON.stringify(state.error));
if (state.terminal && !state.financial_pending) { console.log(state.output ?? state.error); process.exit(0); }
}
}
await new Promise(resolve => setTimeout(resolve, 1500));
}
console.log(job.output ?? job.error);// Node.js 18+. Save your customized input in input.json.
import { readFileSync } from 'node:fs';
import { randomUUID } from 'node:crypto';
const base = process.env.WEBOT_BASE_URL!.replace(/\/$/, '');
const key = process.env.WEBOT_API_KEY!;
const input = JSON.parse(readFileSync('input.json', 'utf8'));
const nonce = process.env.WEBOT_JOB_NONCE || randomUUID(); // Persist before submission.
async function post(path: string, body: unknown, nonce?: string) {
const response = await fetch(base + path, {method:'POST', headers:{
Authorization:`Bearer ${key}`, 'Content-Type':'application/json',
...(nonce ? {'Idempotency-Key':nonce} : {})}, body:JSON.stringify(body)});
const json = await response.json();
if (!response.ok) throw new Error(JSON.stringify(json));
return json;
}
const {quote} = await post('/api/v1/models/creative_492647f86055b5115d3bc0ff/quote', {input});
const job = await post('/api/v1/models/creative_492647f86055b5115d3bc0ff/requests', {input, quoted_credits:quote.credits_consumed}, nonce);
console.log(job); // Stable WEBOT request_id, events_url, result_url.
// Stream saved webhook state. Reconnect ONLY the event stream, not the generation.
while (!job.terminal || job.financial_pending) {
const stream = await fetch(job.events_url, {headers:{Authorization:`Bearer ${key}`}});
if (!stream.ok) throw new Error(`Event stream HTTP ${stream.status}`);
let buffer = '';
for await (const chunk of stream.body.pipeThrough(new TextDecoderStream())) {
buffer += chunk;
let end;
while ((end = buffer.indexOf('\n\n')) !== -1) {
const event = buffer.slice(0, end); buffer = buffer.slice(end + 2);
const data = event.split('\n').find(line => line.startsWith('data: '));
if (!data) continue;
const state = JSON.parse(data.slice(6));
if (state.error && !state.status) throw new Error(JSON.stringify(state.error));
if (state.terminal && !state.financial_pending) { console.log(state.output ?? state.error); process.exit(0); }
}
}
await new Promise(resolve => setTimeout(resolve, 1500));
}
console.log(job.output ?? job.error);# Python 3.9+, pip install requests
import json, os, time, uuid, requests
base = os.environ['WEBOT_BASE_URL'].rstrip('/')
headers = {'Authorization': 'Bearer ' + os.environ['WEBOT_API_KEY']}
with open('input.json', encoding='utf-8') as file:
input_data = json.load(file)
nonce = os.environ.get('WEBOT_JOB_NONCE') or str(uuid.uuid4()) # Persist before submitting.
def post(path, body, extra=None):
response = requests.post(base + path, headers={**headers, **(extra or {})}, json=body, timeout=180)
response.raise_for_status()
return response.json()
quote = post('/api/v1/models/creative_492647f86055b5115d3bc0ff/quote', {'input': input_data})['quote']
job = post('/api/v1/models/creative_492647f86055b5115d3bc0ff/requests', {'input': input_data, 'quoted_credits': quote['credits_consumed']}, {'Idempotency-Key': nonce})
state = job
while not state['terminal'] or state.get('financial_pending', False):
# Reconnect while nonterminal; this reads WEBOT's database, never a provider status API.
with requests.get(job['events_url'], headers=headers, stream=True, timeout=(10, 40)) as stream:
stream.raise_for_status()
for line in stream.iter_lines(decode_unicode=True):
if line and line.startswith('data: '):
state = json.loads(line[6:])
if 'status' not in state: raise RuntimeError(state)
if state['terminal'] and not state.get('financial_pending', False): break
if not state['terminal'] or state.get('financial_pending', False): time.sleep(1.5)
print(state['output'] if state['status'] == 'completed' else state['error'])<?php // PHP 8.1+ with cURL
$base = rtrim(getenv('WEBOT_BASE_URL'), '/');
$input = json_decode(file_get_contents('input.json'), false, 64, JSON_THROW_ON_ERROR);
$nonce = getenv('WEBOT_JOB_NONCE') ?: bin2hex(random_bytes(16)); // Persist this before submission.
function post(string $path, array $body, ?string $nonce = null): array {
global $base;
$headers = ['Authorization: Bearer '.getenv('WEBOT_API_KEY'), 'Content-Type: application/json'];
if ($nonce) $headers[] = 'Idempotency-Key: '.$nonce;
$ch = curl_init($base.$path);
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER=>true, CURLOPT_POST=>true,
CURLOPT_TIMEOUT=>180, CURLOPT_HTTPHEADER=>$headers,
CURLOPT_POSTFIELDS=>json_encode($body, JSON_THROW_ON_ERROR)]);
$raw = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch);
if ($raw === false || $status < 200 || $status >= 300) throw new RuntimeException('WEBOT HTTP '.$status);
return json_decode($raw, true, 64, JSON_THROW_ON_ERROR);
}
$quote = post('/api/v1/models/creative_492647f86055b5115d3bc0ff/quote', ['input'=>$input])['quote'];
$job = post('/api/v1/models/creative_492647f86055b5115d3bc0ff/requests', ['input'=>$input, 'quoted_credits'=>$quote['credits_consumed']], $nonce);
echo json_encode($job, JSON_PRETTY_PRINT); // Connect to events_url with the same Bearer header.// Go 1.20+; save as main.go.
package main
import ("bytes"; "encoding/json"; "fmt"; "io"; "net/http"; "os"; "strings"; "time"; "crypto/rand"; "encoding/hex")
func main() {
base := strings.TrimRight(os.Getenv("WEBOT_BASE_URL"), "/")
raw, err := os.ReadFile("input.json"); if err != nil { panic(err) }
nonce := os.Getenv("WEBOT_JOB_NONCE")
if nonce == "" { b := make([]byte,16); if _,err:=rand.Read(b);err!=nil {panic(err)}; nonce=hex.EncodeToString(b) }
// Persist nonce before the submission; reuse on ambiguous responses.
client := &http.Client{Timeout:180*time.Second}
post := func(path string, body any, id string) map[string]any {
data, err := json.Marshal(body); if err != nil {panic(err)}
req, err := http.NewRequest("POST",base+path,bytes.NewReader(data)); if err!=nil {panic(err)}
req.Header.Set("Authorization","Bearer "+os.Getenv("WEBOT_API_KEY")); req.Header.Set("Content-Type","application/json")
if id!="" {req.Header.Set("Idempotency-Key",id)}
res,err:=client.Do(req); if err!=nil {panic(err)}; defer res.Body.Close()
data,err=io.ReadAll(res.Body); if err!=nil {panic(err)}
if res.StatusCode<200||res.StatusCode>=300 {panic(string(data))}
var result map[string]any; if err=json.Unmarshal(data,&result);err!=nil {panic(err)}; return result
}
input:=json.RawMessage(raw)
quote:=post("/api/v1/models/creative_492647f86055b5115d3bc0ff/quote",map[string]any{"input":input},"")["quote"].(map[string]any)
job:=post("/api/v1/models/creative_492647f86055b5115d3bc0ff/requests",map[string]any{"input":input,"quoted_credits":quote["credits_consumed"]},nonce)
fmt.Println(job) // Stream events_url with the same Authorization header.
}// Java 11+, Jackson databind dependency; class Main in Main.java.
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.time.Duration;
import java.util.UUID;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.node.ObjectNode;
public class Main {
static final ObjectMapper json = new ObjectMapper();
static final HttpClient client = HttpClient.newHttpClient();
static final String base = System.getenv("WEBOT_BASE_URL").replaceAll("/$", "");
static JsonNode post(String path, JsonNode body, String nonce) throws Exception {
var b = HttpRequest.newBuilder(URI.create(base+path)).timeout(Duration.ofSeconds(180))
.header("Authorization","Bearer "+System.getenv("WEBOT_API_KEY")).header("Content-Type","application/json")
.POST(HttpRequest.BodyPublishers.ofString(json.writeValueAsString(body)));
if(nonce!=null)b.header("Idempotency-Key",nonce);
var r=client.send(b.build(),HttpResponse.BodyHandlers.ofString());
if(r.statusCode()<200||r.statusCode()>=300)throw new IllegalStateException(r.body());
return json.readTree(r.body());
}
public static void main(String[] args) throws Exception {
var input=json.readTree(Files.readString(Path.of("input.json")));
ObjectNode body=json.createObjectNode();body.set("input",input);
var quote=post("/api/v1/models/creative_492647f86055b5115d3bc0ff/quote",body,null).get("quote");
body.put("quoted_credits",quote.get("credits_consumed").asInt());
String nonce=System.getenv("WEBOT_JOB_NONCE");if(nonce==null)nonce=UUID.randomUUID().toString(); // Persist before POST.
var job=post("/api/v1/models/creative_492647f86055b5115d3bc0ff/requests",body,nonce);System.out.println(job);
// Subscribe to job.events_url with Authorization; use BodyHandlers.ofLines().
}
}// .NET 8 console app, top-level statements.
using System.Net.Http;
using System.Text;
using System.Text.Json.Nodes;
var client = new HttpClient { Timeout = TimeSpan.FromSeconds(180) };
var root = Environment.GetEnvironmentVariable("WEBOT_BASE_URL")!.TrimEnd('/');
var key = Environment.GetEnvironmentVariable("WEBOT_API_KEY");
async Task<JsonNode> Post(string path, JsonNode body, string? nonce = null) {
using var req = new HttpRequestMessage(HttpMethod.Post, root + path);
req.Headers.Add("Authorization", "Bearer " + key);
if (nonce != null) req.Headers.Add("Idempotency-Key", nonce);
req.Content = new StringContent(body.ToJsonString(), Encoding.UTF8, "application/json");
using var res = await client.SendAsync(req);
var raw = await res.Content.ReadAsStringAsync();res.EnsureSuccessStatusCode();
return JsonNode.Parse(raw)!;
}
var input = JsonNode.Parse(await File.ReadAllTextAsync("input.json"));
var body = new JsonObject { ["input"] = input };
var quote = await Post("/api/v1/models/creative_492647f86055b5115d3bc0ff/quote", body);
body["quoted_credits"] = quote["quote"]!["credits_consumed"]!.GetValue<int>();
var nonce = Environment.GetEnvironmentVariable("WEBOT_JOB_NONCE") ?? Guid.NewGuid().ToString(); // Persist before submitting.
var job = await Post("/api/v1/models/creative_492647f86055b5115d3bc0ff/requests", body, nonce);
Console.WriteLine(job); // Subscribe to events_url with the same Bearer header and ResponseHeadersRead.# Ruby 3+, standard library only.
require 'net/http'
require 'json'
require 'securerandom'
base = ENV.fetch('WEBOT_BASE_URL').sub(%r{/$}, '')
post = lambda do |path, body, nonce = nil|
uri = URI(base + path)
req = Net::HTTP::Post.new(uri)
req['Authorization'] = 'Bearer ' + ENV.fetch('WEBOT_API_KEY')
req['Content-Type'] = 'application/json'
req['Idempotency-Key'] = nonce if nonce
req.body = JSON.generate(body)
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, read_timeout: 180) { |http| http.request(req) }
raise res.body unless res.is_a?(Net::HTTPSuccess)
JSON.parse(res.body)
end
input = JSON.parse(File.read('input.json'))
quote = post.call('/api/v1/models/creative_492647f86055b5115d3bc0ff/quote', {'input' => input})['quote']
nonce = ENV['WEBOT_JOB_NONCE'] || SecureRandom.uuid # Persist this before submission.
job = post.call('/api/v1/models/creative_492647f86055b5115d3bc0ff/requests', {'input' => input, 'quoted_credits' => quote['credits_consumed']}, nonce)
puts JSON.pretty_generate(job) # Subscribe to events_url with the same Authorization header.// Swift 5.9 server-side/CLI only. Do not embed customer keys in shipped apps.
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
@main struct Main {
static func main() async throws {
let env=ProcessInfo.processInfo.environment
let base=env["WEBOT_BASE_URL"]!.trimmingCharacters(in: CharacterSet(charactersIn:"/"))
let input=try JSONSerialization.jsonObject(with: Data(contentsOf:URL(fileURLWithPath:"input.json")))
func post(_ path:String,_ body:[String:Any],_ nonce:String?=nil) async throws -> [String:Any] {
var req=URLRequest(url:URL(string:base+path)!);req.httpMethod="POST";req.timeoutInterval=180
req.setValue("Bearer "+env["WEBOT_API_KEY"]!,forHTTPHeaderField:"Authorization")
req.setValue("application/json",forHTTPHeaderField:"Content-Type")
if let nonce {req.setValue(nonce,forHTTPHeaderField:"Idempotency-Key")}
req.httpBody=try JSONSerialization.data(withJSONObject:body)
let (data,res)=try await URLSession.shared.data(for:req)
guard let http=res as? HTTPURLResponse,(200..<300).contains(http.statusCode) else {throw NSError(domain:"WEBOT",code:1)}
return try JSONSerialization.jsonObject(with:data) as! [String:Any]
}
let quote=try await post("/api/v1/models/creative_492647f86055b5115d3bc0ff/quote",["input":input])["quote"] as! [String:Any]
let nonce=env["WEBOT_JOB_NONCE"] ?? UUID().uuidString // Persist before submission.
let job=try await post("/api/v1/models/creative_492647f86055b5115d3bc0ff/requests",["input":input,"quoted_credits":quote["credits_consumed"]!],nonce)
print(job) // Subscribe to events_url with the same Authorization header.
}
}// Server-side Kotlin/JVM 17+, Gradle dependencies: OkHttp 4.12, org.json 20240303.
import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody
import org.json.JSONObject
import java.io.File
import java.util.UUID
import java.util.concurrent.TimeUnit
fun main() {
val base=System.getenv("WEBOT_BASE_URL").trimEnd('/')
val client=OkHttpClient.Builder().readTimeout(180,TimeUnit.SECONDS).build()
fun post(path:String,body:JSONObject,nonce:String?=null):JSONObject {
val b=Request.Builder().url(base+path).header("Authorization","Bearer "+System.getenv("WEBOT_API_KEY"))
.post(body.toString().toRequestBody("application/json".toMediaType()))
if(nonce!=null)b.header("Idempotency-Key",nonce)
return client.newCall(b.build()).execute().use {res ->
val raw=res.body!!.string();check(res.isSuccessful){raw};JSONObject(raw)
}
}
val body=JSONObject().put("input",JSONObject(File("input.json").readText()))
val quote=post("/api/v1/models/creative_492647f86055b5115d3bc0ff/quote",body).getJSONObject("quote")
body.put("quoted_credits",quote.getInt("credits_consumed"))
val nonce=System.getenv("WEBOT_JOB_NONCE") ?: UUID.randomUUID().toString() // Persist before submission.
val job=post("/api/v1/models/creative_492647f86055b5115d3bc0ff/requests",body,nonce)
println(job) // Subscribe to events_url with the same Authorization header.
}5. Receive all results
The response includes a stable WEBOT request_id, events_url and result_url. Subscribe with a Bearer-authenticated HTTP stream. Nonterminal streams end after 25 seconds; reconnect to the same URL after at least 1.5 seconds. Current saved state is replayed immediately, including completion that happened while disconnected. A terminal event contains the result envelope. The JSON terminal flag describes generation completion. Keep reconnecting while financial_pending is true; stop after the terminal event confirms financial settlement. Never poll provider status/results. Native browser EventSource cannot send a Bearer header; keep the key on your server.
Completed output contains the full model result, including every generated media/document item, not just the first URL. Failed output is null with error and refund_state. Results are strictly limited to the key owner, including on reseller domains. Model-independent aliases: /api/v1/requests/{request_id}/result and /events. Revoking a key blocks subsequent reads and streams; saved results remain accessible with another valid key of the same account.
6. Schemas and parameter defaults
Required fields are marked with *. Required text must contain non-whitespace content. Defaults apply when an optional parameter is omitted; null, false, 0 and an empty array are distinct values. “No documented default” means WEBOT does not invent one. Examples are sample inputs, not defaults. WEBOT generation constraints can require an explicit value even when the provider publishes an automatic default.
Input schema · fields, constraints and defaults
| Parameter | Type | Required | Default when omitted | Description / constraints |
|---|---|---|---|---|
video_url | string | Yes * | No documented default | URL of the input video |
options | object | null | No | No documented default | Additional Sync.so generation options. If options.sync_mode is set, it overrides the top-level sync_mode field. |
options.variant0.active_speaker_detection | object | null | No | No documented default | Active speaker detection configuration for videos with multiple people. |
options.variant0.active_speaker_detection.variant0.v3 | boolean | null | No | No documented default | Whether to use Sync.so's active speaker detection v3. |
options.variant0.active_speaker_detection.variant0.face_image | string | null | No | No documented default | Base64 encoded face image for manual speaker selection. |
options.variant0.active_speaker_detection.variant0.frame_number | integer | null | No | No documented default | Frame index for manual speaker selection coordinates. |
options.variant0.active_speaker_detection.variant0.bounding_boxes_url | string | null | No | No documented default | URL to a JSON file containing per-frame bounding boxes. |
options.variant0.active_speaker_detection.variant0.use_v2 | boolean | null | No | No documented default | Deprecated Sync.so option for active speaker detection v2. |
options.variant0.active_speaker_detection.variant0.auto_detect | boolean | null | No | No documented default | Whether to automatically detect and apply generation to the active speaker. |
options.variant0.active_speaker_detection.variant0.bounding_boxes | array | null | No | No documented default | Per-frame bounding boxes [x1, y1, x2, y2] for the detected face. |
options.variant0.active_speaker_detection.variant0.coordinates | array | null | No | No documented default | Reference point [x, y] on the speaker's face in frame_number. |
options.variant0.temperature | number | null | No | No documented default | Controls how expressive lipsync can be; 0 is least expressive, 1 is most expressive. Sync.so handles this natively for sync-3, so this option is ignored by sync-3. |
options.variant0.prompt | string | null | No | No documented default | Emotion prompt for generation. This is a Sync.so option primarily used by react-1. |
options.variant0.occlusion_detection_enabled | boolean | null | No | No documented default | Whether to detect occlusion during generation. Sync.so handles this automatically for sync-3, so this option is ignored by sync-3. |
options.variant0.model_mode | string | null | No | No documented default | Edit region for the model. This is a Sync.so option primarily used by react-1. |
options.variant0.sync_mode | string | null | No | No documented default | Defines how to handle duration mismatches between video and audio inputs. Overrides the top-level sync_mode when provided. |
audio_url | string | Yes * | No documented default | URL of the input audio |
sync_mode | string | No | "cut_off" | Lipsync mode when audio and video durations are out of sync. enum: ["cut_off","loop","bounce","silence","remap"] |
enable_safety_checker | boolean | No | true |
{
"title": "Sync3Input",
"properties": {
"video_url": {
"title": "Video Url",
"type": "string",
"description": "URL of the input video"
},
"options": {
"anyOf": [
{
"title": "Sync3GenerationOptions",
"properties": {
"active_speaker_detection": {
"anyOf": [
{
"title": "Sync3ActiveSpeakerDetection",
"properties": {
"v3": {
"title": "V3",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether to use Sync.so's active speaker detection v3."
},
"face_image": {
"title": "Face Image",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Base64 encoded face image for manual speaker selection."
},
"frame_number": {
"title": "Frame Number",
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"description": "Frame index for manual speaker selection coordinates."
},
"bounding_boxes_url": {
"title": "Bounding Boxes Url",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "URL to a JSON file containing per-frame bounding boxes."
},
"use_v2": {
"title": "Use V2",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Deprecated Sync.so option for active speaker detection v2."
},
"auto_detect": {
"title": "Auto Detect",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether to automatically detect and apply generation to the active speaker."
},
"bounding_boxes": {
"title": "Bounding Boxes",
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
],
"description": "Per-frame bounding boxes [x1, y1, x2, y2] for the detected face."
},
"coordinates": {
"title": "Coordinates",
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"minItems": 2,
"maxItems": 2
},
{
"type": "null"
}
],
"description": "Reference point [x, y] on the speaker's face in frame_number."
}
},
"type": "object",
"x-webot-order-properties": [
"auto_detect",
"v3",
"use_v2",
"frame_number",
"coordinates",
"bounding_boxes",
"bounding_boxes_url",
"face_image"
]
},
{
"type": "null"
}
],
"description": "Active speaker detection configuration for videos with multiple people."
},
"temperature": {
"title": "Temperature",
"anyOf": [
{
"minimum": 0,
"type": "number",
"maximum": 1
},
{
"type": "null"
}
],
"description": "Controls how expressive lipsync can be; 0 is least expressive, 1 is most expressive. Sync.so handles this natively for sync-3, so this option is ignored by sync-3."
},
"prompt": {
"title": "Prompt",
"anyOf": [
{
"type": "string",
"enum": [
"happy",
"sad",
"angry",
"disgusted",
"surprised",
"neutral"
]
},
{
"type": "null"
}
],
"description": "Emotion prompt for generation. This is a Sync.so option primarily used by react-1."
},
"occlusion_detection_enabled": {
"title": "Occlusion Detection Enabled",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether to detect occlusion during generation. Sync.so handles this automatically for sync-3, so this option is ignored by sync-3."
},
"model_mode": {
"title": "Model Mode",
"anyOf": [
{
"type": "string",
"enum": [
"lips",
"face",
"head",
"lipsync",
"emotion",
"talking_head"
]
},
{
"type": "null"
}
],
"description": "Edit region for the model. This is a Sync.so option primarily used by react-1."
},
"sync_mode": {
"title": "Sync Mode",
"anyOf": [
{
"type": "string",
"enum": [
"cut_off",
"loop",
"bounce",
"silence",
"remap"
]
},
{
"type": "null"
}
],
"description": "Defines how to handle duration mismatches between video and audio inputs. Overrides the top-level sync_mode when provided."
}
},
"type": "object",
"x-webot-order-properties": [
"sync_mode",
"model_mode",
"prompt",
"temperature",
"active_speaker_detection",
"occlusion_detection_enabled"
]
},
{
"type": "null"
}
],
"description": "Additional Sync.so generation options. If options.sync_mode is set, it overrides the top-level sync_mode field."
},
"audio_url": {
"title": "Audio Url",
"type": "string",
"description": "URL of the input audio"
},
"sync_mode": {
"title": "Sync Mode",
"type": "string",
"default": "cut_off",
"enum": [
"cut_off",
"loop",
"bounce",
"silence",
"remap"
],
"description": "Lipsync mode when audio and video durations are out of sync."
},
"enable_safety_checker": {
"title": "Enable Safety Checker",
"default": true,
"type": "boolean"
}
},
"type": "object",
"required": [
"video_url",
"audio_url"
],
"x-webot-order-properties": [
"video_url",
"audio_url",
"sync_mode",
"options",
"enable_safety_checker"
]
}Output (inside result.output) schema · fields, constraints and defaults
| Parameter | Type | Required | Default when omitted | Description / constraints |
|---|---|---|---|---|
video | object | Yes * | No documented default | The generated video |
video.url | string | Yes * | No documented default | The URL where the file can be downloaded from. |
video.file_name | string | null | No | No documented default | The name of the file. It will be auto-generated if not provided. |
video.file_size | integer | null | No | No documented default | The size of the file in bytes. |
video.content_type | string | null | No | No documented default | The mime type of the file. |
{
"title": "Sync3Output",
"properties": {
"video": {
"title": "File",
"properties": {
"url": {
"title": "Url",
"type": "string",
"description": "The URL where the file can be downloaded from."
},
"file_name": {
"title": "File Name",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The name of the file. It will be auto-generated if not provided.",
"examples": [
"z9RV14K95DvU.png"
]
},
"file_size": {
"title": "File Size",
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "The size of the file in bytes.",
"examples": [
4404019
]
},
"content_type": {
"title": "Content Type",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The mime type of the file.",
"examples": [
"image/png"
]
}
},
"type": "object",
"required": [
"url"
],
"x-webot-order-properties": [
"url",
"content_type",
"file_name",
"file_size"
],
"description": "The generated video"
}
},
"type": "object",
"required": [
"video"
],
"x-webot-order-properties": [
"video"
]
}Errors and limits
401 invalid/expired/revoked key · 403 key scope or domain mismatch · 404 unavailable model or unowned request · 409 quote changed, balance, concurrency or idempotency conflict · 413 JSON exceeds 2 MB · 415 wrong content type · 422 invalid fields/media · 429 rate limit · 503 temporary/ambiguous submission. Respect Retry-After. Current limits per account: 12 quotes/submissions, 120 result reads and 8 stream connections per minute. One submission preparation at a time per account. Do not automatically regenerate failed jobs.
Your requests
Sync Lipsync 3 - Video to Video · Your account only
Select Requests to load your history.
| Request ID | Created at (IST) | Status | Credits used | Refunded | Processing time | Report |
|---|
Your model analytics
Sync Lipsync 3 - Video to Video · Request dates in IST
Select Analytics to load your metrics.
Request counts
Daily requests by their current status
Request outcomes
Completed, failed and pending requests
Credits used
Daily recorded charges before refunds
Processing time
Daily average for completed requests with recorded timing
Processing percentiles
Completed requests only · Time from submission to recorded completion
How to use Sync Lipsync 3 — Video to Video
Give the model the required face image or video and speech audio. It adjusts mouth movement to match the speech.
Required inputs
- Video Url: The source video or videos. The model needs an accessible file in a supported format. Check length, resolution and audio requirements in the form before submitting.
- Audio Url: The source sound or speech recording. Clear audio helps the model interpret it. Check the accepted file type, duration and whether the model expects speech, music or another sound.
Workflow
- Prepare your source material and fill the required inputs above. Review the supported settings for this model.
- Sign in to calculate the credit estimate. Review the estimate before choosing Generate.
- Keep this model page open while the request runs. Completed results arrive in the result area; use the available player or download controls to review the output.
When to use this workflow
- Create a speaking portrait or synchronise a clip, where supported.
- Match visible mouth movement to a voice recording.
Key settings
- Video Url
- The source video or videos. The model needs an accessible file in a supported format. Check length, resolution and audio requirements in the form before submitting.
- Audio Url
- The source sound or speech recording. Clear audio helps the model interpret it. Check the accepted file type, duration and whether the model expects speech, music or another sound.
- Sync Mode
- How lip sync handles different audio and video lengths. Cut-off trims, loop repeats, and other modes follow the model’s documented timing rule. This is media alignment, not the server’s asynchronous job mode. Supported choices: "cut_off", "loop", "bounce", "silence", "remap"
- Options
- A group of detailed controls for this particular tool. Set the child fields as documented; the group itself is not a single quality value.
- Active Speaker Detection
- How the lip-sync tool selects the person who is speaking when several people are visible. Automatic detection estimates the speaker; manual references can select a face when supported.
- V3
- How the lip-sync tool selects the person who is speaking when several people are visible. Automatic detection estimates the speaker; manual references can select a face when supported.