process_video

Submit a video-processing job.

• Method: POST
• Path: /process_video

Request Body

{
  "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": {},
  "recording": {},
  "video_start_local_time": "2025-03-17T22:27:33",
  "start_seconds": 0,
  "end_seconds": 30,
  "mode": "KNOWN_OBJECT_DETECTION",
  "base_image_path": null,
  "plugins": {},
  "validation": {}
}

Field	Type	Description
name	string	Friendly job name.
input_video_path	string	Input video file path.
rotate_video	number	Rotation in degrees: 0, 90, 180, or 270.
output_video_path	string	Output file path for generated video.
frame_rate	number	Processing frame rate.
index_for_search	boolean	Whether results should be indexed for archive search.
search_index_types	string[]	Search index types to build when indexing is enabled.
regions	Region[]	Detection regions and configuration.
lines	Line[]	Optional named lines used by detection conditions.
real_time	boolean	When true, process the video at real-time speed.
video_start_interval	number	Offset interval used by the video-processing workflow.
output_all_frames	boolean	Whether to write all frames to the output file.
effects	Effects	Optional overlay settings.
recording	Recording	Optional recording settings.
video_start_local_time	string	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 used by selected modes or plugins.
plugins	object	Optional plugin configuration.
validation	Validation	Optional validation settings.

Success Response

{
  "success": true,
  "message": null,
  "data": {
    "video_id": 42
  }
}