POST
/
v1
/
lipsync
/
create_lipsync
curl --request POST \
  --url https://os.gan.ai/v1/lipsync/create_lipsync \
  --header 'Content-Type: application/json' \
  --header 'ganos-api-key: <api-key>' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "inputs": {
    "input_video_url": "<string>",
    "input_audio_url": "<string>",
    "use_audio_from_video": false
  },
  "webhook_data": {
    "enabled": false,
    "webhook_url": "<string>"
  }
}'
{
  "title": "<string>",
  "description": "<string>",
  "inference_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "video_url": "<string>",
  "thumbnail_url": "<string>",
  "status": "draft",
  "input_video": "<string>",
  "input_audio": "<string>",
  "use_audio_from_video": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
ganos-api-key
string
header
required

Use the API key generated from our website to programmatically interact with our endpoints. This key authorizes your requests, allowing you to access and utilize our services securely.

Body

application/json
​
inputs
object
required

Inputs required for LipSync Inferences

​
title
string | null

Title

​
description
string | null

Description

​
webhook_data
object | null

This endpoint allows you to register a webhook, which can be used to get the generation state of the LipSynced video

Response

200
application/json
Successful Response
​
title
string | null
​
description
string | null
​
inference_id
string

Unique identifier for the generated video

​
video_url
string | null

Publicly accessible and downloadable video url of the LipSynced Video

​
thumbnail_url
string | null

Represents the CloudFront URL of the thumbnail, initially null while being generated, and returns the URL once available

​
status
enum<string>
Available options:
draft,
processing,
failed,
suceeded,
deleted
​
input_video
string

URL of the original input video.

​
input_audio
string

URL of the original input audio.

​
use_audio_from_video
boolean

If true, then the audio stream from the video is used for lipsyncing

​
created_at
string

ISO 8601 formatted timestamp.