Skip to main content
POST
/
video
/
demo
Trigger New Video Generation
curl --request POST \
  --url https://whilter-api-host/video/demo \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "client-request-id": "<string>",
  "customer-id": "<string>",
  "use-case-id": "<string>",
  "user-id": "<string>",
  "reference-record-id": "<string>",
  "phrase-texts": [
    "<string>"
  ],
  "image-texts": [
    "<string>"
  ],
  "video-texts": [
    "<string>"
  ],
  "image-urls": [
    "<string>"
  ],
  "video-urls": [
    "<string>"
  ]
}'
{
  "status": "SUCCESS",
  "message": "Request accepted",
  "client-request-id": "<string>",
  "whilter-request-id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
client-request-id
string
required

Unique identifier for the client request

​
customer-id
string
required

Customer identifier

​
use-case-id
string
required

Template identifier for the video generation use case

​
user-id
string
required

User identifier

​
reference-record-id
string

Optional reference record identifier

​
phrase-texts
string[]

Array of text phrases to be used in video generation

​
image-texts
string[]

Array of image-related text content

​
video-texts
string[]

Array of video-related text content

​
image-urls
string<uri>[]

Array of image URLs to be used in video generation

​
video-urls
string<uri>[]

Array of video URLs to be used in video generation

Response

200 - application/json

Video generation request accepted

​
status
enum<string>
required

Status of the video generation request

Available options:
SUCCESS,
FAILURE
​
message
string
required

Response message

Example:

"Request accepted"

​
client-request-id
string
required

The original client request identifier

​
whilter-request-id
string
required

Generated request identifier for tracking