Skip to main content

​
Upload request fields

Fields sent as multipart/form-data to POST /api/v1/videos/upload.
​
file
file
required
The video file to upload. Supported container formats: mp4, mov, avi, mkv, webm.
​
template_video_id
string
The video_id of a previously uploaded video to use as a style template. Providing this at upload time associates the template with the file for later use when creating a job.
​
webhook_url
string
A URL the engine will POST to when processing for this video’s associated jobs completes.

​
VideoUploadResponse

Returned in the data field of a successful POST /api/v1/videos/upload response.
​
video_id
string
required
Unique identifier assigned to the uploaded video. Use this value as video_id when creating a processing job.
​
filename
string
required
The original filename of the uploaded file as provided in the multipart form data.
​
file_size_bytes
integer
required
Size of the uploaded file in bytes.
​
uploaded_at
string
required
ISO 8601 timestamp indicating when the file was received and stored (e.g., "2024-04-05T10:30:00Z").
​
storage_url
string
required
Internal URL referencing the file’s location within the engine’s storage backend. This is an engine-internal value and is not accessible from outside the service.
​
metadata
object
required
Technical properties extracted from the video file at upload time. See VideoMetadata below.

​
VideoMetadata

The metadata object nested inside VideoUploadResponse. It contains technical properties extracted from the video file by the engine at upload time.
​
width
integer
required
Video frame width in pixels.
​
height
integer
required
Video frame height in pixels.
​
duration_seconds
float
required
Total playback duration of the video in seconds.
​
frame_rate
float
required
Playback frame rate in frames per second (fps).
​
codec
string
required
Video codec used to encode the file (e.g., "h264", "h265").
​
bitrate_kbps
integer
required
Video bitrate in kilobits per second.
​
format
string
required
Container format of the uploaded file (e.g., "mp4", "mov").