CRcreatify
product_to_videos

GET /api/product_to_videos/

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
type'product_anyshot' | 'product_avatar'
  • product_anyshot - Product AnyShot
  • product_avatar - Product Avatar
product_urlstring uri required

URL of the product image to use for video generation (must be a direct image URL, e.g. PNG, JPG, WEBP).

aspect_ratio'9x16' | '16x9' | '1x1'
  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
override_avatarstring uuid nullable

Override avatar for the video. Default is null.

product_showcase_urlstring nullable

The sample diagram url of the product you wish to generate.

image_promptstring nullable

User prompt for generate image description

video_promptstring nullable

User prompt for generate video description

status'initializing' | 'image_generating' | 'image_generated' | 'video_generating' | 'video_generated' | 'failed' required
generated_video_urlstring required

The generated video url.

generated_photo_urlstring required

The generated image url.

created_atstring date-time required
updated_atstring date-time required
webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

failed_reasonstring required

The generated image url.

regen_typestring required

The generated image url.

regen_source_idstring required

The generated video url.

Changes

  • 8423ba73b422Revision changes
    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before