Skip to main content
GET
/
api
/
product_to_videos
/
{id}
cURL
curl --request GET \
  --url https://api.creatify.ai/api/product_to_videos/{id}/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_url": "<string>",
  "generated_video_url": "<string>",
  "generated_photo_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "failed_reason": "<string>",
  "regen_type": "<string>",
  "regen_source_id": "<string>",
  "type": "product_anyshot",
  "aspect_ratio": "16x9",
  "override_avatar": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_showcase_url": "<string>",
  "image_prompt": "<string>",
  "video_prompt": "<string>",
  "webhook_url": "<string>"
}

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this product to video.

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
product_url
string<uri>
required

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

Maximum string length: 200
​
status
enum<string>
required

Product to video task status: one of [initializing, image_generating, image_generated, video_generating, video_generated, failed]

Available options:
initializing,
image_generating,
image_generated,
video_generating,
video_generated,
failed
​
generated_video_url
string
required
read-only

The generated video url.

​
generated_photo_url
string
required
read-only

The generated image url.

​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
failed_reason
string
required
read-only

The generated image url.

​
regen_type
string
required
read-only

The generated image url.

​
regen_source_id
string
required
read-only

The generated video url.

​
type
enum<string>
default:product_anyshot

The type of the product video flow.

  • product_anyshot - Product AnyShot
  • product_avatar - Product Avatar
Available options:
product_anyshot,
product_avatar
​
aspect_ratio
enum<string>
default:16x9

Aspect ratio of the image and video

  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
Available options:
9x16,
16x9,
1x1
​
override_avatar
string<uuid> | null

Override avatar for the video. Default is null.

​
motion_style

The motion style of the product avatar when start generate video.The prerequisite is that the image has an avatar.

  • talking - Talking
  • display - Display
Available options:
talking,
display
​
product_showcase_url
string | null

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

​
image_prompt
string | null

User prompt for generate image description

​
video_prompt
string | null

User prompt for generate video description

​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum string length: 200