Skip to main content
POST
/
media
/
demo
Trigger New Video Generation
curl --request POST \
  --url https://whilter-api-host/media/demo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client-request-id": "<string>",
  "customer-id": "<string>",
  "use-case-id": "<string>",
  "user-id": "<string>",
  "data": {
    "global_assets": {
      "images": [
        "<string>"
      ],
      "videos": [
        "<string>"
      ],
      "icons": [
        "<string>"
      ]
    },
    "global_cohorts": [
      {}
    ],
    "personalization_fields": {},
    "frame_segments": [
      {}
    ]
  },
  "reference-record-id": "<string>"
}
'
{
  "status": "SUCCESS",
  "message": "Request accepted",
  "client-request-id": "<string>",
  "whilter-request-id": "<string>"
}

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