Skip to content
DashboardGet API Key

Lipsync

Endpoints for creating and retrieving lip sync requests.

Generate lip sync from URLs
client.lipsync.generate(LipsyncGenerateParams { inputs, disable_active_speaker_detection, reference_id } body, RequestOptionsoptions?): LipsyncGenerate { request_id, status }
POST/v1/lipsync/generate
Generate lip sync from uploaded media
client.lipsync.generateWithMedia(LipsyncGenerateWithMediaParams { audio, video, disable_active_speaker_detection, 2 more } body, RequestOptionsoptions?): LipsyncGenerate { request_id, status }
POST/v1/lipsync/generate-with-media
ModelsExpand 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.

LipsyncRequests

Endpoints for creating and retrieving lip sync requests.

Get lip sync request
client.lipsync.requests.retrieve(stringid, RequestOptionsoptions?): LipsyncRequest { id, created_at, status, 5 more }
GET/v1/lipsync/requests/{id}
List lip sync requests
client.lipsync.requests.list(RequestListParams { limit, offset, reference_id } query?, RequestOptionsoptions?): RequestListResponse { data, pagination }
GET/v1/lipsync/requests
ModelsExpand Collapse
LipsyncRequest { id, created_at, status, 5 more }
id: string

Lip sync request ID.

formatuuid
created_at: string

Request creation time in UTC.

formatdate-time
status: string

Current request status.

error_message?: string

Failure message when status is failed.

finished_at?: string

Request processing completion time in UTC.

formatdate-time
output_url?: string

URL to the generated output media, when available.

formaturi
reference_id?: string

Client-provided identifier for this request.

started_at?: string

Request processing start time in UTC.

formatdate-time