π Introduction
With this Product Video API, you can transform a product image into a customized short-form video ad. The workflow includes:- Uploading a product image to create a record and generate a preview image.
- Converting the preview image into a video using a specified record ID.
- Regenerating a new record from an existing preview image or video for further customization.
βοΈ Quickstart Guide
β Prerequisites
Before you begin, ensure you have:- A Creatify account with API access
- Your API credentials (see Authentication Guide)
πΌοΈ Step 1: Upload Product Image and Create Record
Use this endpoint to upload a product image, create a record, and generate a preview image.π§ Example Response from POST /api/product_to_videos/gen_image/
β οΈ Save the id β youβll need it to generate the video or regen the image.
Step 1.1: Check the generating image status.
Use this endpoint to check if the image is generated and retrieve the final output.β³ ProductToVideo is generating preview image status starts asinitializing, and the status isimage_generatingwhen image generating, itβs will returnimage_generateduntil the image generated successful.
π Webhook Callback Example
If you provide awebhook_url, Creatify will notify your backend of the generation result:
Step 1.2:(Optional) Regen the image.
Use this endpoint to regen the preview image using a task ID. It will return a newProductToVideo task ID, allowing you to select different tasks for the next step.
β³ This response will keep the same as first step you had invoke gen_image to generated image.
π Webhook Callback Example
If you provide awebhook_url, Creatify will notify your backend of the generation result:
ποΈ Step 2: Generate Video from Preview Image Task.
Use this endpoint to convert the preview image associated with a task ID into a video.π§ Example Response from POST /api/product_to_videos/{id}/gen_video/
β οΈ Save the id β youβll need it to regen video.
π Webhook Callback Example
If you provide awebhook_url, Creatify will notify your backend of the generation result:
Step 2.1: Check the generating video status.
Use this endpoint to check if the video is generated and retrieve the final output.β³ ProductToVideo is generating video status starts asvideo_generating, itβs will returnvideo_generateduntil the video generated successful.
Also can wait the webhook response about this id backing result if you had sent webhook_url on API request.
Step 2.2:(Optional) Regenerate the video.
Use this endpoint to regen the video using a task ID. It will return a newProductToVideo task ID.
β³ This response will keep the same as first step you had invoke gen_video to generated video.
π Webhook Callback Example
If you provide awebhook_url, Creatify will notify your backend of the generation result:
π― Summary
| Step | Endpoint |
|---|---|
| Generate image | POST /api/product_to_videos/gen_image/ |
| Check Status | GET /api/product_to_videos/{id}/ |
| Generate Video | POST /api/product_to_videos/{id}/gen_video/ |
| Regenerate image | POST /api/product_to_videos/{id}/regen_image/ |
| Regenerate video | POST /api/product_to_videos/{id}/regen_video/ |
| API Reference | Product-to-Video Reference |

