Skip to main content

Creates a video clip

POST /v1/videoclip

Summary​

Creates a video clip.

Details​

Request body: JSON object.

This endpoint is not used by devices.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • deviceID (integer (int64), optional)
  • deviceName (string, optional)
  • fileID (integer (int64), optional)
  • localFilePath (string, optional)
  • height (integer (int64), optional)
  • width (integer (int64), optional)
  • framesPerSecond (number (double), optional)
  • startTime (integer (int64), optional)
  • startTimeMs (integer (int64), optional)
  • clipLengthInSeconds (number (double), optional)
  • videoClipStatus (integer (int64), optional)
  • videoClipTypeID (integer (int64), optional)
  • videoClipParameters (string, optional)

Example

{
  "deviceID": 201,
  "deviceName": "WearableDevice",
  "fileID": 1,
  "localFilePath": "Example value",
  "height": 1,
  "width": 1,
  "framesPerSecond": 1,
  "startTime": 1,
  "startTimeMs": 1,
  "clipLengthInSeconds": 1,
  "videoClipStatus": 1,
  "videoClipTypeID": 1,
  "videoClipParameters": "Example value"
}

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"
}