Video Creation

Generate professional videos from your products and templates. Monitor rendering progress via webhooks.

POST

/videos

Start a new video generation job. This is an asynchronous operation.

Request Body

FieldTypeDescription
template_idstringID of the template to use.
product_idstringID of the product to feature.
user_promptobjectJSON object containing custom prompt data.
languagestringTarget language for the video (e.g., "en").
webhook_urlstringURL to receive webhook events.
GET

/videos/:id

Retrieve the status and details of a specific video.

GET

/videos

Retrieve a list of all videos generated by your account.

Webhooks

We send HTTP POST requests to your specified webhook_url when the video status changes.

Event Types

video.completed

Sent when video rendering is successfully finished.

video.failed

Sent if an error occurs during rendering.

Webhook Payload Example

{
  "event": "video.completed",
  "data": {
    "id": "vid_987654321",
    "status": "completed",
    "video_url": "https://cdn.productclip.com/videos/vid_987654321.mp4",
    "thumbnail_url": "https://cdn.productclip.com/thumbnails/vid_987654321.jpg",
    "credits_used": 10,
    "created_at": "2023-11-23T10:05:00Z",
    "completed_at": "2023-11-23T10:06:30Z"
  }
}