Sign in

v1

latestOpenAPI 3.0.32026-07-2691139249.7 KB
product_to_videos

Retrieve a list of videos, with an optional ids param to filter vdieo by their UUIDs.

get/api/product_to_videos/

Query parameters

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.