Skip to main content
POST
Trigger New Video Generation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

data
object
required

Media generation data containing assets, cohorts, personalization fields, and frame segments

reference-record-id
string

Optional reference record identifier

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