Entwickler-API

Lipsync API-Plattform

Erzeuge Lip-Sync-Videos programmatisch mit unserer leistungsstarken REST-API

API-Schlüssel

Verwalte deine Authentifizierungsschlüssel

Gib einen einprägsamen Namen an (optional)

Anmeldung erforderlich

Bitte melde dich an, um API-Schlüssel zu erstellen und zu verwalten.

Preise, die zu dir passen

Starte mit flexiblen und wettbewerbsfähigen Tarifen

API-Preise

Pay-as-you-go

Hinweis: API-Credits und Benutzer-Credits sind unabhängig und nicht austauschbar.

Preis
Credits
Pro Credit

Hinweise:

Mindestabrechnung: 5 Sekunden pro Generierung
480p: 2 Credits pro Sekunde
720p: 4 Credits pro Sekunde
lipsync-video: Ist das Video länger als das Audio, wird es gekürzt; ist das Audio länger, wird automatisch verlängert. Abrechnung: beim Kürzen nach Audiolänge, beim Verlängern nach Videolänge.
lipsync-image-multi: Bei "meanwhile" erfolgt die Abrechnung nach der maximalen Audiolänge; sonst nach Summe von "left_audio" und "right_audio".
Beispiel 1:
3 Sekunden Audio in 720p = 5 s × 4 = 20 Credits
(Mindestabrechnung gilt)
Beispiel 2:
10 Sekunden Audio in 480p = 10 × 2 = 20 Credits

Authentifizierung

Schütze deine API-Anfragen

Füge den API-Schlüssel in allen Anfragen im Authorization-Header ein:

Authorization: Bearer sk_XXXX_YYYY

Verfügbare Endpunkte

RESTful API-Endpunkte

POST/api/v1/lipsync-video

Video-zu-Video mit Audiotausch (Lip-Sync beibehalten)

POST/api/v1/lipsync-image

Bild + Audio → Einsprecher-Avatar

POST/api/v1/lipsync-image-multi

Bild + zwei Audios → Mehrsprecher-Avatar (Gespräch/Dialog)

GET/api/v1/jobs/{requestId}

Jobstatus abfragen und Ergebnis abrufen

Detaillierte Parameter

Vollständige Endpunktspezifikationen

Alle Endpunkte teilen eine gemeinsame Struktur: optionaler webhook und modellspezifische formState-Parameter.

POST /api/v1/lipsync-video

Ersetzt die Tonspur eines bestehenden Videos unter Beibehaltung des Lip-Syncs

Top-Level-Parameter:
webhookoptional

Deine Callback-URL (HTTPS). Wir senden das Ergebnis per POST nach Abschluss.

formStateerforderlich

Objekt mit allen Generierungsparametern (siehe unten).

formState-Parameter:
videoerforderlich

Öffentliche URL des Quellvideos (MP4, MOV, etc.)

audioerforderlich

Öffentliche URL des Audios (MP3, WAV, etc.)

resolutionoptional

"480p" oder "720p" (Standard: 480p)

mask_imageoptional

Öffentliche URL des Maskenbilds (beschränkt den Lip-Sync-Bereich)

promptoptional

Text für Stilvorgaben

seedoptional

Ganzzahliger Seed für Reproduzierbarkeit

Async Workflow

Choose how to receive your results

All API calls are asynchronous. You have two options to retrieve results:

Option 1: Webhook (Recommended)

Provide a webhook URL in the JSON body. We will POST the result to your endpoint when the job completes.

Benefits:
  • No need to poll repeatedly
  • Instant notification when job completes
  • More efficient for long-running jobs (30-120 seconds typical)

Option 2: Polling

Omit the webhook parameter and use the returned requestId to poll GET /api/v1/jobs/{requestId} every 5-10 seconds until status is "completed".

Use when:
  • You cannot expose a public webhook endpoint
  • Testing or debugging

Example with Webhook:

POST /api/v1/lipsync-image
Authorization: Bearer sk_XXXX_YYYY
Content-Type: application/json

{
  "webhook": "https://your-app.example.com/webhooks/lipsync",
  "formState": {
    "image": "https://.../face.png",
    "audio": "https://.../voice.mp3",
    "resolution": "720p",
    "seed": 42
  }
}

// Immediate Response:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing"
}

// Later, when job completes, we POST to your webhook:
POST https://your-app.example.com/webhooks/lipsync
Content-Type: application/json

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "model": "lipsync-image",
  "status": "completed",
  "output": "https://.../result.mp4",
  "error": "",
  "executionTime": 12345,
  "timings": null
}

Example without Webhook (Polling):

// Step 1: Submit job (no webhook parameter)
POST /api/v1/lipsync-image
Authorization: Bearer sk_XXXX_YYYY
Content-Type: application/json

{
  "formState": {
    "image": "https://.../face.png",
    "audio": "https://.../voice.mp3",
    "resolution": "720p"
  }
}

// Immediate Response:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing"
}

// Step 2: Poll for status (repeat every 5-10 seconds)
GET /api/v1/jobs/550e8400-e29b-41d4-a716-446655440000
Authorization: Bearer sk_XXXX_YYYY

// Response while processing:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "model": "lipsync",
  "status": "processing",
  "output": null,
  "error": "",
  "executionTime": null,
  "timings": null
}

// Response when completed:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "model": "lipsync-image",
  "status": "completed",
  "output": "https://.../result.mp4",
  "error": "",
  "executionTime": 12345,
  "timings": null
}

// Response if failed:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "model": "lipsync-image",
  "status": "failed",
  "output": null,
  "error": "Invalid audio format",
  "executionTime": null,
  "timings": null
}

Complete Code Examples

Ready-to-use integration examples

Node.js with Webhook (Recommended)

import fetch from 'node-fetch';
import express from 'express';

const API_KEY = 'Bearer sk_XXXX_YYYY';
const BASE_URL = 'https://lipsync.studio/api/v1';

// Set up webhook server to receive results
const app = express();
app.use(express.json());

app.post('/webhooks/lipsync', (req, res) => {
  const { id, status, output, error, model } = req.body;
  
  console.log('✅ Job update received!');
  console.log('Job ID:', id);
  console.log('Model:', model);
  console.log('Status:', status);
  if (status === 'completed') {
    console.log('Video URL:', output);
  } else if (status === 'failed') {
    console.error('Error:', error);
  }
  
  // TODO: Save output URL to your database, send notification, etc.
  
  res.status(200).json({ received: true });
});

app.listen(3000, () => {
  console.log('Webhook server listening on port 3000');
});

// Submit job with webhook
async function submitJobWithWebhook() {
  const webhookUrl = 'https://your-public-domain.com/webhooks/lipsync';
  
  const res = await fetch(`${BASE_URL}/lipsync-image`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': API_KEY
    },
    body: JSON.stringify({
      webhook: webhookUrl,
      formState: {
        image: 'https://example.com/portrait.jpg',
        audio: 'https://example.com/speech.mp3',
        resolution: '720p'
      }
    })
  });
  
  const data = await res.json();
  console.log('Job submitted:', data.id);
  console.log('Waiting for webhook callback...');
  
  // You don't need to poll! The result will be POSTed to your webhook.
}

submitJobWithWebhook();