Post generate - sync. docs

POST

generate

curl --request POST \
  --url https://api.sync.so/v2/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "model": "lipsync-1.9.0-beta",
  "input": [
    {
      "type": "video",
      "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4"
    },
    {
      "type": "audio",
      "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortaud-27623a4f-edab-4c6a-8383-871b18961a4a.wav"
    }
  ],
  "options": {
    "pads": [
      0,
      5,
      0,
      0
    ],
    "speedup": 1,
    "output_format": "mp4",
    "sync_mode": "bounce",
    "fps": 25,
    "output_resolution": [
      1280,
      720
    ],
    "active_speaker": true
  },
  "webhookUrl": "https://your-server.com/webhook"
}'

{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "model": "<string>",
  "input": [
    {
      "type": "<string>",
      "url": "<string>"
    }
  ],
  "webhookUrl": {},
  "options": {},
  "outputUrl": {},
  "outputDuration": {},
  "error": "<string>"
}

Getting started

Authenticate and make your first request to the generate API.

Authorize

Enter your API key in the x-api-key field within the Authorization section.

Enter your x-api-key in the Authorization section

Enter params

Enter the params in the body section:

Fill out the body with the required parameters.

Example input:

{
  "model": "sync-1.9.0-beta",
  "input": [
    {
      "type": "audio",
      "url": "https://example.com/audio.mp3"
    },
    {
      "type": "video",
      "url": "https://example.com/video.mp4"
    }
  ],
}

Send a request

Click the Send button to submit your request. After the submission, you will receive a response that includes the id of your job, the current status, and the details to track your job.

{
  "id": "unique_job_id",
  "createdAt": "date_time",
  "status": "PROCESSING",
  "model": "sync-1.9.0-beta",
  "input": [
    {
      "type": "audio",
      "url": "https://example.com/audio.mp3"
    },
    {
      "type": "video",
      "url": "https://example.com/video.mp4"
    }
  ],
  "webhookUrl": null,
  "options": {},
  "stream": false,
  "outputUrl": null
}

Your job’s status will start as PENDING and move to PROCESSING. Use the returned id with the GET /lipsync/{id} endpoint to periodically poll for the status of your job. This polling is crucial for knowing when your video is ready.

What to do next

Explore options for monitoring your job’s progress and receiving updates.

Authorizations

x-api-key

string

header

required

Body

application/json

Input for creating generation job

model

enum<string>

required

name of the model to use for generation.

Available options:

lipsync-1.8.0,

lipsync-1.8.0-beta,

lipsync-1.7.1,

lipsync-1.6.0,

lipsync-1.9.0-beta

Example:

"lipsync-1.9.0-beta"

input

object[]

required

input media to use for generation. this is an array of media items.

input.type

enum<string>

required

Available options:

video,

audio,

text

Example:

"video"

input.segments_secs

array

Start and end time in seconds for each video segment to apply generation to

Example:

[[5, 10]]

input.segments_frames

array

Start and end frames for each video segment to apply generation to

Example:

[[0, 25]]

input.url

string

Example:

"https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4"

input.provider

object

Integration provider

Example:

[
  {
    "type": "video",
    "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4"
  },
  {
    "type": "audio",
    "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortaud-27623a4f-edab-4c6a-8383-871b18961a4a.wav"
  }
]

options

object

additional options available for generation.

options.pads

number[]

Padding values

Example:

[0, 5, 0, 0]

options.speedup

enum<number>

downscale inputs for faster generations. used to preview changes.

Available options:

1,

2,

3,

4

Example:

1

options.output_format

enum<string>

default:mp4

format of the output media that is generated.

Available options:

mp4,

mov

Example:

"mp4"

options.sync_mode

enum<string>

default:loop

lipsync mode when audio and video durations are out of sync.

Available options:

loop,

bounce,

cut_off,

silence,

remap

Example:

"bounce"

options.fps

number

Frames per second (FPS) for the output video

Example:

25

options.output_resolution

string[]

Resolution of the output video [width, height]

Example:

[1280, 720]

options.active_speaker

boolean

Whether to detect active speaker and apply generation to them

Example:

true

webhookUrl

string

webhook url for generation status updates. once the generation completes we will send a POST request to the webhook url with the generation data.

Example:

"https://your-server.com/webhook"

Response

201

application/json

Job created successfully

string

required

A unique identifier for the generation.

createdAt

string

required

The date and time the generation was created.

status

enum<string>

required

The status of the generation.

Available options:

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REJECTED,

CANCELED,

TIMED_OUT

model

string

required

The name of the model used for generation.

input

object[]

required

An array of input objects containing type and URL.

webhookUrl

object

The URL to the webhook endpoint.

options

object

Options for the generation.

outputUrl

object

The URL of the output media.

outputDuration

object

The duration of the output media.

error

string

The error message if the generation failed.

Error Handling Get generate

curl --request POST \
  --url https://api.sync.so/v2/generate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "model": "lipsync-1.9.0-beta",
  "input": [
    {
      "type": "video",
      "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortvid-03a10044-7741-4cfc-816a-5bccd392d1ee.mp4"
    },
    {
      "type": "audio",
      "url": "https://synchlabs-public.s3.us-west-2.amazonaws.com/david_demo_shortaud-27623a4f-edab-4c6a-8383-871b18961a4a.wav"
    }
  ],
  "options": {
    "pads": [
      0,
      5,
      0,
      0
    ],
    "speedup": 1,
    "output_format": "mp4",
    "sync_mode": "bounce",
    "fps": 25,
    "output_resolution": [
      1280,
      720
    ],
    "active_speaker": true
  },
  "webhookUrl": "https://your-server.com/webhook"
}'

{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "PENDING",
  "model": "<string>",
  "input": [
    {
      "type": "<string>",
      "url": "<string>"
    }
  ],
  "webhookUrl": {},
  "options": {},
  "outputUrl": {},
  "outputDuration": {},
  "error": "<string>"
}

Getting started

API Reference

​Getting started

​What to do next

Authorizations

Body

Response

Getting started

What to do next