Skip to content

Generate lip sync from uploaded media

client.lipsync.generateWithMedia(, ?): LipsyncGenerate { request_id, status }

POST/v1/lipsync/generate-with-media

Starts a lip sync job by uploading one video file and one audio file as multipart form-data.

ParametersExpand Collapse

body: LipsyncGenerateWithMediaParams { audio, video, disable_active_speaker_detection, 2 more }

audio: Uploadable

Target audio file.

video: Uploadable

Source video file.

disable_active_speaker_detection?: boolean

Disable active speaker detection and use max-face lipsync preprocessing.

model?: "lipsync-2"

Optional model selector.

reference_id?: string

Optional client-provided identifier for later retrieval.

ReturnsExpand Collapse

LipsyncGenerate { request_id, status }

request_id: string

Identifier of the created lip sync request.

formatuuid

status: "success"

Current state of the newly created request.

Generate lip sync from uploaded media

import Chamelaion from 'chamelaion';

const client = new Chamelaion({
  apiKey: process.env['CHAMELAION_API_KEY'], // This is the default and can be omitted
});

const lipsyncGenerate = await client.lipsync.generateWithMedia({
  audio: fs.createReadStream('path/to/file'),
  video: fs.createReadStream('path/to/file'),
  model: 'lipsync-2',
  reference_id: 'upload-demo-01',
});

console.log(lipsyncGenerate.request_id);

{
  "status": "success",
  "request_id": "3b7df3e8-f578-44de-b4f5-5f58dd6b89e0"
}

{
  "error": "content-type must be multipart/form-data"
}

{
  "error": "video file is required"
}

{
  "error": "audio file is required"
}

{
  "error": "model must be \"lipsync-2\""
}

{
  "error": "missing authorization header"
}

{
  "error": "invalid authorization format"
}

{
  "error": "missing token"
}

{
  "error": "invalid token"
}

{
  "error": "unauthorized"
}

{
  "error": "token limit reached"
}

{
  "error": "rate limit exceeded"
}

{
  "error": "internal error"
}

Returns Examples

{
  "status": "success",
  "request_id": "3b7df3e8-f578-44de-b4f5-5f58dd6b89e0"
}

{
  "error": "content-type must be multipart/form-data"
}

{
  "error": "video file is required"
}

{
  "error": "audio file is required"
}

{
  "error": "model must be \"lipsync-2\""
}

{
  "error": "missing authorization header"
}

{
  "error": "invalid authorization format"
}

{
  "error": "missing token"
}

{
  "error": "invalid token"
}

{
  "error": "unauthorized"
}

{
  "error": "token limit reached"
}

{
  "error": "rate limit exceeded"
}

{
  "error": "internal error"
}