Skip to content
DashboardGet API Key

List lip sync requests

lipsync.requests.list(RequestListParams**kwargs) -> RequestListResponse
GET/v1/lipsync/requests

Returns a paginated list of lip sync requests for the authenticated account.

ParametersExpand Collapse
limit: Optional[int]

Maximum number of items to return.

minimum1
offset: Optional[int]

Number of items to skip before returning results.

minimum0
reference_id: Optional[str]

Filter requests by exact reference_id.

ReturnsExpand Collapse
class RequestListResponse:
data: List[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

List lip sync requests

import os
from chamelaion import Chamelaion

client = Chamelaion(
    api_key=os.environ.get("CHAMELAION_API_KEY"),  # This is the default and can be omitted
)
requests = client.lipsync.requests.list()
print(requests.data)
{
  "data": [
    {
      "id": "6f82a2d8-a6d4-4e8a-a0fa-e8b09823a2d8",
      "reference_id": "batch-2026-04",
      "status": "completed",
      "created_at": "2026-03-30T11:00:00Z",
      "started_at": "2026-03-30T11:00:04Z",
      "finished_at": "2026-03-30T11:01:09Z",
      "output_url": "https://storage.chamelaion.com/output/6f82a2d8.mp4"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "reference_id": "batch-2026-04",
      "status": "queued",
      "created_at": "2026-03-30T11:02:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 2
  }
}
{
  "data": [
    {
      "id": "0d8e7a7b-1a4a-4af1-b1da-050f7d9d95bc",
      "reference_id": "order-12345-japanese-dub",
      "status": "processing",
      "created_at": "2026-03-31T09:40:00Z",
      "started_at": "2026-03-31T09:40:08Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}
{
  "error": "missing authorization header"
}
{
  "error": "invalid authorization format"
}
{
  "error": "missing token"
}
{
  "error": "invalid token"
}
{
  "error": "unauthorized"
}
{
  "error": "rate limit exceeded"
}
{
  "error": "internal error"
}
Returns Examples
{
  "data": [
    {
      "id": "6f82a2d8-a6d4-4e8a-a0fa-e8b09823a2d8",
      "reference_id": "batch-2026-04",
      "status": "completed",
      "created_at": "2026-03-30T11:00:00Z",
      "started_at": "2026-03-30T11:00:04Z",
      "finished_at": "2026-03-30T11:01:09Z",
      "output_url": "https://storage.chamelaion.com/output/6f82a2d8.mp4"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "reference_id": "batch-2026-04",
      "status": "queued",
      "created_at": "2026-03-30T11:02:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 2
  }
}
{
  "data": [
    {
      "id": "0d8e7a7b-1a4a-4af1-b1da-050f7d9d95bc",
      "reference_id": "order-12345-japanese-dub",
      "status": "processing",
      "created_at": "2026-03-31T09:40:00Z",
      "started_at": "2026-03-31T09:40:08Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 1
  }
}
{
  "error": "missing authorization header"
}
{
  "error": "invalid authorization format"
}
{
  "error": "missing token"
}
{
  "error": "invalid token"
}
{
  "error": "unauthorized"
}
{
  "error": "rate limit exceeded"
}
{
  "error": "internal error"
}