Video Webservice

Generate ranged timelapse clip

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

post/api/video/generateRangedTimelapseClip

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/video/generateRangedTimelapseClip
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

descriptionstring nullable

Description for the timelapse

drawCameraDetailsboolean nullable

Whether to draw camera details on the video

drawTimestampboolean nullable

Whether to draw timestamps on the video

titlestring nullable

Title for the timelapse

videoDurationinteger nullable required

Duration in seconds for the output video

Example request

{
  "drawCameraDetails": true,
  "drawTimestamp": true,
  "sources": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
    }
  ],
  "title": "Subject Tour 2026-04-21",
  "videoDuration": 60
}

Response

OK

clipUuidstring RUUID nullable

base 64 (url-safe) uuid string

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.