Creates a video clip for a device identified by serial number

POST /v1/videoclip/{deviceSerial}

Summary

Creates a video clip for a device identified by serial number.

Authentication

No operation-level security requirement is documented here.

Parameters

Name	In	Type	Required	Description	Example
deviceSerial	path	string	Yes	The device serial number from the route.	Example value

Request Body

Required: Yes

application/json

• key (integer (int64), optional)
• deviceID (integer (int64), optional)
• fileID (integer (int64), optional)
• tSFileID (integer (int64), optional)
• videoClipStatus (integer (int64), optional)
• videoClipTypeID (integer (int64), optional)
• videoClipParameters (string, optional)
• localFilePath (string, optional)
• height (integer (int64), optional)
• width (integer (int64), optional)
• fileSize (integer (int64), optional)
• framesPerSecond (number (double), optional)
• bitrate (integer (int64), optional)
• audioStatus (integer (int64), optional)
• startTime (integer (int64), optional)
• startTimeMs (integer (int64), optional)
• endTime (integer (int64), optional)
• endTimeMs (integer (int64), optional)
• clipLengthInSeconds (number (double), optional)
• tagListID (integer (int64), optional)
• creationDate (string (date-time), optional)

Example

{
  "key": 1,
  "deviceID": 201,
  "fileID": 1,
  "tSFileID": 1,
  "videoClipStatus": 1,
  "videoClipTypeID": 1,
  "videoClipParameters": "Example value",
  "localFilePath": "Example value",
  "height": 1,
  "width": 1,
  "fileSize": 1,
  "framesPerSecond": 1,
  "bitrate": 1,
  "audioStatus": 1,
  "startTime": 1,
  "startTimeMs": 1,
  "endTime": 1,
  "endTimeMs": 1,
  "clipLengthInSeconds": 1,
  "tagListID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}

Responses

200

Success

application/json

• key (integer (int64), optional)
• deviceID (integer (int64), optional)
• fileID (integer (int64), optional)
• tSFileID (integer (int64), optional)
• videoClipStatus (integer (int64), optional)
• videoClipTypeID (integer (int64), optional)
• videoClipParameters (string, optional)
• localFilePath (string, optional)
• height (integer (int64), optional)
• width (integer (int64), optional)
• fileSize (integer (int64), optional)
• framesPerSecond (number (double), optional)
• bitrate (integer (int64), optional)
• audioStatus (integer (int64), optional)
• startTime (integer (int64), optional)
• startTimeMs (integer (int64), optional)
• endTime (integer (int64), optional)
• endTimeMs (integer (int64), optional)
• clipLengthInSeconds (number (double), optional)
• tagListID (integer (int64), optional)
• creationDate (string (date-time), optional)

Example

{
  "key": 1,
  "deviceID": 201,
  "fileID": 1,
  "tSFileID": 1,
  "videoClipStatus": 1,
  "videoClipTypeID": 1,
  "videoClipParameters": "Example value",
  "localFilePath": "Example value",
  "height": 1,
  "width": 1,
  "fileSize": 1,
  "framesPerSecond": 1,
  "bitrate": 1,
  "audioStatus": 1,
  "startTime": 1,
  "startTimeMs": 1,
  "endTime": 1,
  "endTimeMs": 1,
  "clipLengthInSeconds": 1,
  "tagListID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}