Generate ranged timelapse clip

Generate a timelapse where each device facet contributes footage only during its own time ranges.

POST /api/video/generateRangedTimelapseClip

Generate ranged timelapse clip

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/video/generateRangedTimelapseClip \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "sources": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "ranges": [
        {
          "endMs": 123,
          "startMs": 123
        }
      ]
    }
  ],
  "videoDuration": 60
}
'

200

{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request for generating a timelapse where each facet contributes footage only during its own time ranges.

sources · object[] | null · required

One entry per device facet. Each carries its own list of time ranges.

Show child attributes

videoDuration · integer<int32> | null · required

Duration in seconds for the output video

Example:

60

description · string | null

Description for the timelapse

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

title · string | null

Title for the timelapse

Example:

"Subject Tour 2026-04-21"

Response

200 - application/json

OK

Response from generating a ranged timelapse clip.

clipUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

error · boolean | null

errorMsg · string | null

warningMsg · string | null