CRcreatify
lipsyncs_v2

GET /api/lipsyncs_v2/

Changed on

Retrieve a list of records. Optionally filter by ids (UUIDs) and/or a creation time window [created_after, created_before). The window selects records by when they were created; status and credits_used reflect their current state and can change until the job finishes (failed jobs are refunded and report 0 credits).

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Query parameters

created_afterstring date-time

Only return records created at or after this time (inclusive). ISO 8601, e.g. 2026-09-27T00:00:00Z or 2026-09-27T00:00:00+08:00 (URL-encode '+' as %2B). Timestamps without an offset are treated as UTC.

created_beforestring date-time

Only return records created before this time (exclusive). Same format as created_after.

idsstring

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

Response

idstring uuid required
namestring nullable

The name of the lipsync request.

outputstring nullable required

Output video

video_thumbnailstring uri required

Generated Video Thumbnail URL

created_atstring date-time required
updated_atstring date-time required
credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

progressstring required
failed_reasonstring nullable required

The reason for failure, if the lipsync request failed

media_jobstring uuid nullable

The media job associated with the lipsync request.

statusstring required

Status of the lipsync request

webhook_urlstring uri nullable

The webhook URL to be called upon completion of the lipsync request

previewstring nullable required

Preview video

editor_urlstring nullable required

Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled.

aspect_ratio'16x9' | '1x1' | '9x16' required
  • 16x9 - Ratio 16 9
  • 1x1 - Ratio 1 1
  • 9x16 - Ratio 9 16
model_version'standard' | 'aurora_v1' | 'aurora_v1_fast' | 'boreal' | 'aurora_v2'
  • standard - Standard
  • aurora_v1 - Aurora v1
  • aurora_v1_fast - Aurora v1 Fast
  • boreal - Boreal
  • aurora_v2 - Aurora v2

Changes

  • 8423ba73b422Revision changes
    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added to the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status