Skip to content
DashboardGet API Key

Lipsync

Endpoints for creating and retrieving lip sync requests.

Generate lip sync from URLs
lipsync.generate(LipsyncGenerateParams**kwargs) -> LipsyncGenerate
POST/v1/lipsync/generate
Generate lip sync from uploaded media
lipsync.generate_with_media(LipsyncGenerateWithMediaParams**kwargs) -> LipsyncGenerate
POST/v1/lipsync/generate-with-media
ModelsExpand Collapse
class LipsyncGenerate:
request_id: str

Identifier of the created lip sync request.

formatuuid
status: Literal["success"]

Current state of the newly created request.

LipsyncRequests

Endpoints for creating and retrieving lip sync requests.

Get lip sync request
lipsync.requests.retrieve(strid) -> LipsyncRequest
GET/v1/lipsync/requests/{id}
List lip sync requests
lipsync.requests.list(RequestListParams**kwargs) -> RequestListResponse
GET/v1/lipsync/requests
ModelsExpand Collapse
class LipsyncRequest:
id: str

Lip sync request ID.

formatuuid
created_at: datetime

Request creation time in UTC.

formatdate-time
status: str

Current request status.

error_message: Optional[str]

Failure message when status is failed.

finished_at: Optional[datetime]

Request processing completion time in UTC.

formatdate-time
output_url: Optional[str]

URL to the generated output media, when available.

formaturi
reference_id: Optional[str]

Client-provided identifier for this request.

started_at: Optional[datetime]

Request processing start time in UTC.

formatdate-time