ProcessVideo

Request-body reference for POST /process_video.

Example

{
  "name": "warehouse-shift-1",
  "input_video_path": "/input/warehouse.mp4",
  "rotate_video": 0,
  "output_video_path": "/output/warehouse_out.mp4",
  "frame_rate": 5,
  "index_for_search": false,
  "search_index_types": [],
  "regions": [],
  "lines": [],
  "real_time": false,
  "video_start_interval": 0,
  "output_all_frames": true,
  "effects": { "show_bounding_boxes": true },
  "recording": { "enabled": false },
  "video_start_local_time": "2025-03-17T22:27:33Z",
  "start_seconds": 0,
  "end_seconds": 30,
  "mode": "KNOWN_OBJECT_DETECTION",
  "base_image_path": null,
  "plugins": {},
  "validation": { "triggers": [] }
}

Fields

Field	Type	Description
name	string	Job name.
input_video_path	string	Input video path.
rotate_video	number	Rotation in degrees.
output_video_path	string	Output video path.
frame_rate	number	Processing frame rate.
index_for_search	boolean	Whether to index results for archive search.
search_index_types	string[]	Search index types to build.
regions	Region[]	Detection regions.
lines	Line[]	Optional named lines.
real_time	boolean	Whether to process in real time.
video_start_interval	number	Interval offset used during processing.
output_all_frames	boolean	Whether to write all frames to the output.
effects	Effects	Overlay settings.
recording	Recording	Recording settings.
video_start_local_time	string	Video start time in ISO format.
start_seconds	number	Trim start offset in seconds.
end_seconds	number	Trim end offset in seconds.
mode	string	Processing mode.
base_image_path	string	Optional base image path.
plugins	object	Optional plugin configuration.
validation	Validation	Optional validation settings.