Skip to main content
POST
/
api
/
video
/
generateTimelapseClip
Generate timelapse clip
curl --request POST \
  --url https://api2.rhombussystems.com/api/video/generateTimelapseClip \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Daily timelapse of security events",
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "drawCameraDetails": true,
  "drawTimestamp": true,
  "skipNights": true,
  "skipWeekends": false,
  "startTime": 1640995200000,
  "stopTime": 1640998800000,
  "title": "Daily Security Review",
  "videoDuration": 60,
  "videoFormat": "mp4"
}
'
{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for generating a timelapse clip.

​
description
string | null

Description for the timelapse

Example:

"Daily timelapse of security events"

​
deviceUuids
(string<DeviceFacetUuid> | null)[] | null

List of device facet UUIDs to include in the timelapse. UUIDs without a facet defined will default to facet v0

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
drawCameraDetails
boolean | null

Whether to draw camera details on the video

Example:

true

​
drawTimestamp
boolean | null

Whether to draw timestamps on the video

Example:

true

​
skipNights
boolean | null

Whether to skip night time periods

Example:

true

​
skipWeekends
boolean | null

Whether to skip weekend periods

Example:

false

​
startTime
integer<int64> | null

Start time in milliseconds for the timelapse

Example:

1640995200000

​
stopTime
integer<int64> | null

Stop time in milliseconds for the timelapse

Example:

1640998800000

​
title
string | null

Title for the timelapse

Example:

"Daily Security Review"

​
videoDuration
integer<int32> | null

Duration in seconds for the output video

Example:

60

​
videoFormat
string | null

Format for the output video

Example:

"mp4"

Response

200 - application/json

OK

Response object for generating a timelapse clip.

​
clipUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null