create a new generation job

POST

generate

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.7.1-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.7.1-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

headerrequired

Body

application/json

model

enum<string>

default: looprequired

name of the model to use for generation.

Available options:

lipsync-1.8.0-beta,

lipsync-1.7.1,

lipsync-1.6.0

input

object[]

required

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

options

object

additional options available for generation.

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.

Response

201 - application/json

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:

CANCELED,

COMPLETED,

FAILED,

PENDING,

PROCESSING,

REJECTED

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 the status of a generation job

getting started

api reference

​getting started

​what to do next

Authorizations

Body

Response

getting started

what to do next