Create Lip Sync Video Task

Submit a video URL and an audio URL to create a lip sync task. Use the returned task ID to poll for processing status and results.

POST /v2/create_lip_sync_video

Create lip sync video task

cURL

curl --request POST \
  --url https://api.jogg.ai/v2/create_lip_sync_video \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "video_url": "https://res.jogg.ai/source-video.mp4",
  "audio_url": "https://res.jogg.ai/source-audio.wav",
  "playback_type": "normal"
}
'

import requests

url = "https://api.jogg.ai/v2/create_lip_sync_video"

payload = {
    "video_url": "https://res.jogg.ai/source-video.mp4",
    "audio_url": "https://res.jogg.ai/source-audio.wav",
    "playback_type": "normal"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    video_url: 'https://res.jogg.ai/source-video.mp4',
    audio_url: 'https://res.jogg.ai/source-audio.wav',
    playback_type: 'normal'
  })
};

fetch('https://api.jogg.ai/v2/create_lip_sync_video', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jogg.ai/v2/create_lip_sync_video",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'video_url' => 'https://res.jogg.ai/source-video.mp4',
    'audio_url' => 'https://res.jogg.ai/source-audio.wav',
    'playback_type' => 'normal'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jogg.ai/v2/create_lip_sync_video"

	payload := strings.NewReader("{\n  \"video_url\": \"https://res.jogg.ai/source-video.mp4\",\n  \"audio_url\": \"https://res.jogg.ai/source-audio.wav\",\n  \"playback_type\": \"normal\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jogg.ai/v2/create_lip_sync_video")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_url\": \"https://res.jogg.ai/source-video.mp4\",\n  \"audio_url\": \"https://res.jogg.ai/source-audio.wav\",\n  \"playback_type\": \"normal\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/create_lip_sync_video")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"video_url\": \"https://res.jogg.ai/source-video.mp4\",\n  \"audio_url\": \"https://res.jogg.ai/source-audio.wav\",\n  \"playback_type\": \"normal\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "code": 0,
  "msg": "Success",
  "data": {
    "task_id": "3d5c6930-d0da-4f7b-826e-cd1530f6734f",
    "status": "pending"
  }
}

Submit a source video URL and a source audio URL to create a lip sync video task.

Example Usage

curl --request POST \
  --url 'https://api.jogg.ai/v2/create_lip_sync_video' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "video_url": "https://res.jogg.ai/source-video.mp4",
    "audio_url": "https://res.jogg.ai/source-audio.wav",
    "playback_type": "normal"
  }'

Related Guides

Get Lip Sync Task Status

Check task processing status and results

Authorizations

x-api-key · string · header · required

API key for authentication. Obtain your key from the JoggAI dashboard.

Body

application/json

video_url · string<uri> · required

Source video URL

Example:

"https://res.jogg.ai/source-video.mp4"

audio_url · string<uri> · required

Source audio URL

Example:

"https://res.jogg.ai/source-audio.wav"

playback_type · enum<string> · default: normal

Playback strategy when source video is shorter than audio

Available options: normal, normal_reverse, normal_reverse_by_audio

Example:

"normal"

Response

200 - application/json

Success

code · integer · required

Business status code:

• 0 - Success
• 10104 - Record not found
• 10105 - Invalid API key
• 18020 - Insufficient credit
• 18025 - No permission to call APIs
• 40000 - Parameter error
• 50000 - System error

Example:

0

msg · string · required

Response message

Example:

"Success"

data · object

Show child attributes